my_todo 3.1.1 → 4.0.0.pre1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b4c70de321e879cf5515fbbd10b78e71f8a69017
-  data.tar.gz: 53acd0ce0b42fe4cd6baf3bfbadd7c272350c739
+SHA256:
+  metadata.gz: 1ef19ecc95c4315bd6662a9b3b6d6bfd5a684884e5c38492d541990a5860bd41
+  data.tar.gz: b4c7e53d57aec082ef092afebfc2f996de94eabf6953699bd36fa2f314997ca3
 SHA512:
-  metadata.gz: 811c02060a4a567ba1528c55152f40d4075387fee2c3d09f810ea685a9f6f577082fabb4f9af87869ad90338d6d880edafb74eac937ba57e58bb409c8f4a21d6
-  data.tar.gz: cd090f60fd4879456d9ce52e3939d8dd344c5e8acaff04e21a41cee1a8f94b01044d02241f7adc54d43388ebeadb809934001f58ed7146d4ef8176cf092f5ea9
+  metadata.gz: 73ab785f105b1c338671df021039297f8eec3ccc26e7f215fdf91af12b89fd271027b692bf383ebc1f18e9eb0f92c474659592dba5d6a3e460cab1ea79ff8fdf
+  data.tar.gz: c398d1add1165b0b2152d40c7f2aa24ad9159dd5406ab2559ef0c0617583d46d9cc67b62313a35834147f7729904bac45c04c386a2baa22e8fd0faf9e5e972a5

data/README.md

@@ -1,4 +1,4 @@
-# My Todo
+# My ToDo
 [![Code Climate](https://codeclimate.com/github/vmcilwain/my_todo/badges/gpa.svg)](https://codeclimate.com/github/vmcilwain/my_todo)
 
 [![Test Coverage](https://codeclimate.com/github/vmcilwain/my_todo/badges/coverage.svg)](https://codeclimate.com/github/vmcilwain/my_todo/coverage)
@@ -6,100 +6,116 @@
 [![Issue Count](https://codeclimate.com/github/vmcilwain/my_todo/badges/issue_count.svg)](https://codeclimate.com/github/vmcilwain/my_todo)
 
 ## Summary
-This is yet another simple todo application. This was built because I found myself having to create quick reminders when things came up but needing to switch windows from the terminal to the todo application via the GUI. This application is the result of that one annoyance :). It is still a work in progress but I hope you find it useful.
+A CLI todo list / task manager written in Ruby.
+
+### Explanation
+
+Often times while coding either at home or at work, I found myself needing to create quick reminders as things came up. While this happens to everyone, I was getting annoyed with having to switch out of the console to go into another application to add it. I didn't need a GUI to manage my lists if I did things right so that set me down the path to building this CLI application. This application will more than likely always be a work in progress but I hope you find it useful should you want to try it.
+
+## Disclaimer
+
+This code is provided "as is" and any express or implied warranties, including the implied warranties of merchantability and fitness for a particular purpose are disclaimed. In no event shall I or contributors be liable for any direct, indirect, incidental, special, exemplary, or consequential damages (including, but not limited to, procurement of substitute goods or services; loss of use, data, or profits; or business interruption) sustained by you or a third party, however caused and on any theory of liability, whether in contract, strict liability, or tort arising in any way out of the use of this code, even if advised of the possibility of such damage.
 
 ## Features
-* SQLIte3 backend (database is located in $HOME/.my_todo)
-* CRUD actions for todo items (Create, Read, Update & Delete)
-* Tag / Untag todo items to group / ungroup them.
-* Search for todo items
-* Add / Remove additional notes to todo items
 
-## Installation
+* Tagging
+* Search
+* Notes
+
+## Requirements
 
-To install this gem onto your system
+Ruby 2.2 and above
+
+## Installation
 
 ```ruby
 gem install my_todo
 ```
 
-## setup
-Create and migrate the DB - This always needs to be run after every deployment to set the proper paths at the very least.
-
-`my_todo rake db:migrate`
+## Setup
+Create and migrate the database. This should always be done after every version update to ensure proper paths are set at a minium.
 
+```ruby
+mytodo rake db:migrate
+```
 ## Usage
-Simply type `my_todo` to see a list of commands
 
-Example of creating a todo item
+Type `mytodo` to see the help text
+
+### Examples
+
+#### Creating a todo item
 
 ```ruby
-my_todo create --body='hello world'
+mytodo create 'hello world'
 ```
 
-will display
+will then ask if you want to give it an initial status
+
+```
+0: None
+1: In Progress
+2: Waiting Feedback
+3: Complete
+4: Punted
 
+Choose a status for item (1)
 ```
-ToDo CREATED!
 
+`In Progress` is the default (just hit enter to keep going). Setting it to None will leave it blank.
 
-ID: 1 | Created On: 2016-10-04 | Tags: default | Status: In Progress | Complete: false | Notes: 0
+Once selected and `Enter`/`Return` is pressed, something like the following should display:
+ 
+```
+Item Created
+
+id: 1     notes: 0     tags: Default
+created: 2018-10-11     status: In Progress (done: No)
 
 hello world
-****************************************************************************************************
 ```
 
-Example of listing pending todos
+#### List pending todo items
 
 ```ruby
-my_todo list
+mytodo list
 ```
 
-will display
+will display something like
 
 ```
-ToDos FOUND: 2
+Items Found: 2
 
-ID: 1 | Created On: 2016-10-04 | Tags: default | Status: In Progress  | Complete: false | Notes: 0
+id: 1     notes: 0     tags: Default
+created: 2018-10-11     status: In Progress (done: No)
 
 hello world
 ****************************************************************************************************
+id: 2     notes: 0     tags: Default
+created: 2018-10-11     status: In Progress (done: No)
 
-ID: 2 | Created On: 2016-10-05 | Tags: default | Status: In Progress | Complete: false | Notes: 0
-
-hello world 2
+goodbye world
 ****************************************************************************************************
 ```
 
-Use aliasing to shorten the syntax:
-```
-#aliases
-alias m='my_todo'
-alias mlist='my_todo list'
-alias mcreate='my_todo create'
-alias mupdate='my_todo update'
-alias mdelete='my_todo delete'
-alias mtag='my_todo tag'
-alias mrmtag='my_todo rm_tag'
-alias mnotes='my_todo notes'
-alias mrmnote='my_todo rm_note'
-alias msearch='my_todo search'
-alias mnote='my_todo note'
-```
+## Removing the gem and data
 
-Functions can be created around these actions to possibly shorten the syntax that much more
+Uninstall the gem: `gem uninstall my_todo`
+
+Delete `$HOME/.my_todo` to remove the data
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then `RAILS_ENV=development bin/my_todo rake db:migrate` to create the development DB. You can also run `RAILS_ENV=development bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then `RAILS_ENV=development bin/mytodo rake db:migrate` to create the development DB (in the db directory). You can also run `RAILS_ENV=development bin/console` for an interactive prompt that will allow you to experiment.
 
-NOTE: In development, all commands must be run with the RAILS_ENV included. This is to make sure any changes made go to the right db. Any commands ran without the RAILS_ENV specified will default to production.
+##### Note: In development, all commands must be run with the RAILS_ENV included. This is to make sure any data written made go to the right db. Any commands ran without the RAILS_ENV specified will default to production. Example: `RAILS_ENV=development bin/mytodo list`
 
 ## Testing
 
-Run `RAILS_ENV=test bin/my_todo rake db:migrate` to create the test db. Then run `RAILS_ENV=test bundle exec rake` to run the RSpec tests.
+Run `RAILS_ENV=test bin/mytodo rake db:migrate` to create the test db (in spec/db). Then run `bundle exec rake` to run the RSpec tests.
 
 ## Releasing
+
 To release a new version,
 * update the version number in `version.rb`
 * tag the the code `git tag v1.0.0`
@@ -107,9 +123,6 @@ To release a new version,
 * then run `bundle exec rake build`
 * `gem push pkg/my_todo-verion`
 
-## Removing the gem
-To remove the gem simply type `gem uninstall my_todo`. Along with this, you will need to remove `$HOME/.my_todo` to remove the database.
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/vmcilwain/my_todo. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/Rakefile

@@ -5,8 +5,11 @@ require 'standalone_migrations'
 StandaloneMigrations::Tasks.load_tasks
 
 unless ENV['RAILS_ENV'] == 'production'
+  
   require "rspec/core/rake_task"
+  
   RSpec::Core::RakeTask.new(:spec)
 
   task :default => :spec
+
 end

data/bin/{my_todo → mytodo}

@@ -34,7 +34,7 @@ if exec_type == 'rake'
   # Generate standalone migration file configs for sqlite3
   if ENV['RAILS_ENV'] == 'production'
     Setup.start(%w[db_config])
-    Setup.start(%w[standard_migrations_override])
+    # Setup.start(%w[standard_migrations_override])
   end
   # Get current working directory
   pwd=Dir.pwd

data/{lib/db → db}/config.yml

@@ -1,18 +1,18 @@
 # To Run: rake db:migrate
 development:
   adapter: sqlite3
-  database: lib/db/todos_development.sqlite3
+  database: db/todos_development.sqlite3
   pool: 5
   encoding: utf8
 # To Run: RAILS_ENV=test rake db:migrate
 test:
   adapter: sqlite3
-  database: lib/db/todos_test.sqlite3
+  database: spec/db/todos_test.sqlite3
   pool: 5
   encoding: utf8
 # To Run: RAILS_ENV=production rake db:migrate
 production:
   adapter: sqlite3
-  database: lib/db/todos_production.sqlite3
+  database: db/todos_production.sqlite3
   pool: 5
   encoding: utf8

data/{lib/db → db}/migrate/20160912172429_create_items.rb

@@ -1,8 +1,8 @@
-class CreateItems < ActiveRecord::Migration[5.0]
+class CreateItems < ActiveRecord::Migration[5.2]
   def change
     create_table :items do |t|
       t.string :body
-      t.boolean :done
+      t.boolean :done, default: false
       t.timestamps null: false
     end
   end

data/{lib/db → db}/migrate/20160913134552_create_tags.rb

@@ -1,4 +1,4 @@
-class CreateTags < ActiveRecord::Migration[5.0]
+class CreateTags < ActiveRecord::Migration[5.2]
   def change
     create_table :tags do |t|
       t.string :name, index: true

data/{lib/db → db}/migrate/20160913134610_create_stubs.rb

@@ -1,4 +1,4 @@
-class CreateStubs < ActiveRecord::Migration[5.0]
+class CreateStubs < ActiveRecord::Migration[5.2]
   def change
     create_table :stubs do |t|
       t.belongs_to :item

data/{lib/db → db}/migrate/20161003121448_create_notes.rb

@@ -1,4 +1,4 @@
-class CreateNotes < ActiveRecord::Migration[5.0]
+class CreateNotes < ActiveRecord::Migration[5.2]
   def change
     create_table :notes do |t|
       t.belongs_to :item

data/{lib/db → db}/migrate/20161005133023_add_detailed_status_to_items.rb

@@ -1,4 +1,4 @@
-class AddDetailedStatusToItems < ActiveRecord::Migration[5.0]
+class AddDetailedStatusToItems < ActiveRecord::Migration[5.2]
   def change
     add_column :items, :detailed_status, :string
   end

data/db/migrate/20161220143613_add_default_to_item_done.rb

@@ -0,0 +1,5 @@
+class AddDefaultToItemDone < ActiveRecord::Migration[5.2]
+  def change
+    # change_column :items, :done, :boolean, default: false
+  end
+end

data/{lib/db → db}/schema.rb

@@ -10,27 +10,19 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 20161220143613) do
+ActiveRecord::Schema.define(version: 2016_12_20_143613) do
 
   create_table "items", force: :cascade do |t|
-    t.string   "body"
-    t.boolean  "done",            default: false
-    t.datetime "created_at",                      null: false
-    t.datetime "updated_at",                      null: false
-    t.string   "status"
-    t.string   "detailed_status"
-  end
-
-  create_table "lists", force: :cascade do |t|
-    t.string   "name"
-    t.string   "value"
+    t.string "body"
+    t.boolean "done", default: false
     t.datetime "created_at", null: false
     t.datetime "updated_at", null: false
+    t.string "detailed_status"
   end
 
   create_table "notes", force: :cascade do |t|
-    t.integer  "item_id"
-    t.text     "body"
+    t.integer "item_id"
+    t.text "body"
     t.datetime "created_at", null: false
     t.datetime "updated_at", null: false
     t.index ["item_id"], name: "index_notes_on_item_id"

data/lib/my_todo.rb

@@ -1,6 +1,5 @@
 # @author Lovell McIlwain
 # Handles running the todo application
-require "#{__dir__}/my_todo/version"
 require 'thor'
 require 'erb'
 require 'sqlite3'
@@ -8,6 +7,7 @@ require 'active_record'
 require 'active_model'
 require 'yaml'
 require 'ransack'
+# require_relative "../lib/my_todo/version"
 require_relative 'my_todo/ar_base'
 require_relative 'my_todo/models/item'
 require_relative 'my_todo/models/stub'
@@ -16,129 +16,19 @@ require_relative 'my_todo/models/note'
 require_relative 'my_todo/modules/templates'
 require_relative 'my_todo/modules/finders'
 require_relative 'my_todo/modules/my_todo_actions'
+require_relative 'my_todo/modules/actions'
+
 module MyTodo
-  # Todo tasks using thor gem
   class Todo < Thor
-    # Add additional thor tasks
     include Thor::Actions
 
-    # Private methods
     no_commands do
       include Templates
       include Finders
       include MyTodoActions
     end
 
-    desc 'list --status=done', 'List todos. Default: undone, [all], [done], [undone]'
-    option :status, default: nil
-    def list
-      say "ToDos FOUND: #{all_items.count}"
-      print_list
-    end
-
-    desc "create --body='some text' [--done=true] [--tags='tag1 tag2']", 'Create a todo'
-    option :body
-    option :tags, default: 'default'
-    def create
-      begin
-        say 'ToDo CREATED!'
-        create_item(options)
-        print_item
-      rescue ActiveRecord::RecordInvalid => e
-        say e.message
-      end
-    end
-
-    desc "update --id=TODO_ID --body='some text' [--done=true]", 'Change an existing todo'
-    option :id
-    option :body
-    def update
-      begin
-        update_item(options)
-        say 'ToDo UPDATED!'
-        print_item
-      rescue ActiveRecord::RecordInvalid => e
-        say e.message
-      end
-    end
-
-    desc 'delete', 'Destroy a todo'
-    option :id, required: true
-    def delete
-      begin
-        item.destroy!
-        say 'ToDo DESTROYED!'
-      rescue StandardError => e
-        say e.message
-      end
-    end
-
-    desc 'search', 'Find a todo by item body, tag name or note body'
-    option :text, required: true
-    def search
-      @items = Item.ransack(body_or_detailed_status_or_tags_name_or_notes_body_cont: options[:text]).result
-      say "ToDos FOUND: #{@items.count}"
-      say "Search based on ransack search: body_or_detailed_status_or_tags_name_or_notes_body_cont"
-      print_search_results
-    end
-
-    desc "tag --id=TODO_ID --tag=TAG_NAME", 'Add a tag to an existing todo'
-    option :id
-    option :tag
-    def tag
-      begin
-        item.tags.create!(name: options[:tag])
-        print_list item.reload
-      rescue StandardError => e
-        say e.message
-      end
-    end
-
-    desc 'rm_tag --id=TODO_ID --tag=TAG_NAME', 'Remove tag from an existing todo'
-    option :id
-    option :tag
-    def rm_tag
-      begin
-        item.tags.where(name: options[:tag]).first.destroy!
-        print_list item.reload
-      rescue StandardError => e
-        say e.message
-      end
-    end
-
-    desc "note --id=TODO_ID --body='text'", 'Adds note to existing item'
-    option :id
-    option :body
-    def note
-      begin
-        item.notes.create(body: options[:body])
-        print_notes
-      rescue StandardError => e
-        say e.message
-      end
-    end
-
-    desc 'rm_note --id=TODO_ID --noteid=NOTE_ID', 'Remove note for exsiting item'
-    option :id
-    option :noteid
-    def rm_note
-      begin
-        item.notes.where(id: options[:noteid]).first.destroy!
-        print_list item.reload
-      rescue StandardError => e
-        say e.message
-      end
-    end
-
-    desc 'notes --id=TODO_ID', 'Display notes for a given todo'
-    option :id
-    def notes
-      begin
-        print_notes
-      rescue StandardError => e
-        say e.message
-      end
-    end
+    include MyTodo::Actions
   end
 end