Project

bulldoggy

0.01
No commit activity in last 3 years
No release in over 3 years
Bulldoggy is a to-do list app inspired by Uncle Bob's Clean Architecture
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.5
>= 0
>= 0
 Project Readme

Bulldoggy

Build Status Code Climate

A to-do list app inspired by Uncle Bob's Clean Architecture.

The idea of is to have a concrete implementation of the architecture and use various deliveries mechanisms and storages that will act as plugins to the core app.

Implementations of the delivery mechanisms are welcome and will be listed here:

Web as the delivery mechanism:

CLI (command line interface) as the delivery mechanism:

Installation

Add this line to your application's Gemfile:

gem 'bulldoggy', '~> 0.0.1.alpha'

And then execute:

$ bundle

Or install it yourself as:

$ gem install bulldoggy --pre

Usage

Adding tasks:

task = Bulldoggy.add_task('go to the cinema')

Checking tasks:

Bulldoggy.check_task(task.id)

Unchecking tasks:

Bulldoggy.uncheck_task(task.id)

Removing tasks:

Bulldoggy.remove(task.id)

Fetching tasks:

Bulldoggy.fetch

Usage with Rails:

Connecting entities to ActiveRecord models

Inside your Rails app, create an initializer and register your repository adapters to make it work with Rails AR models.

config/initializers/bulldoggy.rb:

Bulldoggy::Repository.register :task, TasksRespositoryAdapter.new

TODO: add repository adapter example