my_todo 2.1.0 → 2.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d43fa975defc5843e115f0d8258086d03bebf62
-  data.tar.gz: 8f8d18f7d47fcceade42a7d8bd22fcfce99e81f5
+  metadata.gz: a2f1837cba62f5d258fe7f433ad5679bf50c0d3c
+  data.tar.gz: 9bf63f143f84b658d09ebb6fc42379564bebf289
 SHA512:
-  metadata.gz: ed29e73bb98c43586922c64f549607d8fcff148a708cb5a91c3e5e74e6b7d5fa442d8300138b65ad4d598c1e22684983ea6ce851d21d48c2a6d62c5e10b14347
-  data.tar.gz: 5258f53446840229714aec2d8d394753e2587353f56e324978977373d8193efd822fea920d2a68b72b1a75e8baf464a8411c83bab81521e294a9867806ee4ca4
+  metadata.gz: e34014d8ec9df7510ac8d5cedbfe322f71b0b23ef4f94fe5b5e23eb2feb679d7d0f8d31c930ea5326c8518d6a4b020ce3b95e07bda06f6c79f0f7d144614637e
+  data.tar.gz: 62a79fe9055aadf01da2418f91672008e8387963760a42197249633dc20406978fa63879a9986bd8da07c388fa612c8bafa239b9ee5a7af66b002925338e6534

data/README.md

@@ -1,3 +1,15 @@
+# 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.
+
+## 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
 
 To install this gem onto your system
@@ -50,6 +62,23 @@ Tags: default
 Complete: false
 ```
 
+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 mnote='my_todo note'
+alias mrmnote='my_todo rm_note'
+alias msearch='my_todo search'
+```
+
+Functions can be created around these actions to possibly shorten the syntax that much more
+
 ## 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.

data/bin/my_todo

@@ -32,8 +32,10 @@ if exec_type == 'rake'
   require 'pp'
 
   # Generate standalone migration file configs for sqlite3
-  Setup.start(%w[db_config])
-  Setup.start(%w[standard_migrations_override])
+  if ENV['RAILS_ENV'] == 'production'
+    Setup.start(%w[db_config])
+    Setup.start(%w[standard_migrations_override])
+  end
   # Get current working directory
   pwd=Dir.pwd
   # Go into root of gems directory to load rakefile

data/lib/my_todo.rb

@@ -1,4 +1,4 @@
-# @author Lovell McIlwain#
+# @author Lovell McIlwain
 # Handles running the todo application
 require File.expand_path('../../lib/my_todo/version', __FILE__)
 require 'thor'
@@ -7,6 +7,7 @@ require 'sqlite3'
 require 'active_record'
 require 'active_model'
 require 'yaml'
+require 'ransack'
 require_relative 'ar_base'
 require_relative 'item'
 require_relative 'stub'
@@ -19,22 +20,24 @@ module MyTodo
     # Add additional thor tasks
     include Thor::Actions
 
-    # Private methods/tasks
+    # Private methods
     no_commands do
       def output(item)
-        puts ERB.new(File.read(File.expand_path("../../lib/my_todo/templates/output.erb", __FILE__))).result(binding)
+        say ERB.new(File.read(File.expand_path("../../lib/my_todo/templates/output.erb", __FILE__))).result(binding)
+      end
+
+      def item
+        @item ||= Item.where(id: options[:id]).first
       end
     end
 
-    desc 'list([REQ])', 'list todos. Default: unfinished, [all], [finished], [unfinished]'
-    def list(req=nil)
-      items = case
-      when req == 'all'
+    desc 'list([STATUS])', 'list todos. Default: undone, [all], [done], [undone]'
+    def list(status=nil)
+      items = case status
+      when 'all'
         Item.all
-      when req == 'finished'
+      when 'done'
         Item.where(done: true)
-      when req == 'unfinished'
-        Item.where(done: false)
       else
         Item.where(done: false)
       end
@@ -66,7 +69,6 @@ module MyTodo
     option :updated_at, default: DateTime.now
     def update
       begin
-        item = Item.find(options[:id])
         item.update!(options)
         say 'ToDo UPDATED!'
         output item
@@ -87,11 +89,11 @@ module MyTodo
       end
     end
 
-    desc 'search(ID || BODY)', 'search for todo'
-    def search(req)
-      items = Item.where('id = ? or body like ?', req, "%#{req}%")
+    desc 'search(TEXT)', 'search for todo by item body, tag name or note body'
+    def search(text)
+      items = Item.ransack(body_or_tags_name_or_notes_body_cont: text).result
       say "ToDos FOUND: #{items.count}"
-      items.each {|i| output i}
+      items.each {|item| output item}
     end
 
     desc "tag --id=TODO_ID --tag=TAG_NAME", 'add a tag to an existing todo'
@@ -99,7 +101,6 @@ module MyTodo
     option :tag
     def tag
       begin
-        item = Item.where(id: options[:id]).first
         item.tags.create!(name: options[:tag])
       rescue Exception => e
         say e.message
@@ -111,7 +112,6 @@ module MyTodo
     option :tag
     def rm_tag
       begin
-        item = Item.where(id: options[:id]).first
         item.tags.where(name: options[:tag]).first.destroy!
         output item.reload
       rescue Exception => e
@@ -124,7 +124,6 @@ module MyTodo
     option :body
     def note
       begin
-        item = Item.where(id: options[:id]).first
         item.notes.create(body: options[:body])
         output item.reload
       rescue Exception => e
@@ -137,7 +136,6 @@ module MyTodo
     option :noteid
     def rm_note
       begin
-        item = Item.where(id: options[:id]).first
         item.notes.where(id: options[:noteid]).first.destroy!
         output item.reload
       rescue Exception => e

data/lib/my_todo/version.rb

@@ -1,3 +1,3 @@
 module MyTodo
-  VERSION = "2.1.0"
+  VERSION = "2.6.1"
 end

data/my_todo.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["lovell.mcilwain@gmail.com"]
 
   spec.summary       = %q{A basic todo application with tags.}
-  spec.description   = %q{A terminal based todo application for creating todo items. Adding tags makes for an easy way to group and search for related items.}
+  spec.description   = %q{A terminal based todo application for creating todo items. Adding tags makes for an easy way to group and search for related items. Create additional notes for a todo item as new related information comes up}
   spec.homepage      = "https://github.com/vmcilwain/my_todo"
   spec.license       = "MIT"
 
@@ -28,11 +28,13 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'shoulda-matchers', '~> 3.1'
   spec.add_development_dependency 'byebug', '~> 9.0.5'
   spec.add_development_dependency 'yard', '~> 0.9.5'
+  spec.add_development_dependency 'simplecov', '~> 0.12.0'
   spec.add_dependency 'activerecord', '~> 5.0.0.1'
   spec.add_dependency 'activesupport', '~> 5.0.0.1'
   spec.add_dependency 'thor', '~> 0.19.1'
   spec.add_dependency 'standalone_migrations', '~> 5.0.0'
   spec.add_dependency 'sqlite3', '~> 1.3.11'
+  spec.add_dependency 'ransack', '~> 1.8.2'
 
   spec.metadata["yard.run"] = "yri"
   spec.post_install_message = "Don't forget to migrate the db. `my_todo rake db:migrate`"

data/spec/actions/search_spec.rb

@@ -5,24 +5,27 @@ describe MyTodo do
     context 'success search' do
       before do
         @todo1 = FactoryGirl.create(:item, body: 'nfl')
+        @todo1.tags.create(name: 'tag1')
         @todo2 = FactoryGirl.create(:item, body: 'rocks')
         @todo3 = FactoryGirl.create(:item, body: 'always')
+        @todo3.notes.create(body: 'note1')
       end
 
-      it 'finds todo item by id' do
-        expect{MyTodo::Todo.start( %W(search #{@todo3.id} ))}.to output("ToDos FOUND: 1\n\nID: 3\nToDo: always\nTags: \nComplete: \n\n").to_stdout
-      end
 
       it 'finds todo item by body' do
-        expect{MyTodo::Todo.start( %w[search nfl])}.to output("ToDos FOUND: 1\n\nID: 1\nToDo: nfl\nTags: \nComplete: \n\n").to_stdout
+        expect{MyTodo::Todo.start( %w[search nfl])}.to output("ToDos FOUND: 1\n\nID: 1\nToDo: nfl\nTags: tag1\nComplete: \n\n").to_stdout
       end
-    end
 
-    context 'unsuccessful search' do
-      it 'returns no results when searching by invalid id' do
-        expect{MyTodo::Todo.start( %w(search 1))}.to output("ToDos FOUND: 0\n").to_stdout
+      it 'finds todo items by associated tag' do
+        expect{MyTodo::Todo.start( %w[search tag1])}.to output("ToDos FOUND: 1\n\nID: 1\nToDo: nfl\nTags: tag1\nComplete: \n\n").to_stdout
       end
 
+      it 'finds todo items by associated notes content' do
+        expect{MyTodo::Todo.start( %w[search note1])}.to output("ToDos FOUND: 1\n\nID: 3\nToDo: always\nTags: \nComplete: \n\nNotes:\n\n1: note1\n\n\n").to_stdout
+      end
+    end
+
+    context 'unsuccessful search' do
       it 'returns no results when searching on invalid body' do
         expect{MyTodo::Todo.start( %w(search no_body))}.to output("ToDos FOUND: 0\n").to_stdout
       end

data/spec/spec_helper.rb

@@ -5,6 +5,8 @@ require 'factory_girl_rails'
 require 'shoulda-matchers'
 require 'byebug'
 require 'my_todo'
+require 'simplecov'
+SimpleCov.start
 
 DatabaseCleaner.strategy = :truncation
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: my_todo
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.6.1
 platform: ruby
 authors:
 - Vell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-03 00:00:00.000000000 Z
+date: 2016-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -122,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.5
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -192,8 +206,23 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.11
+- !ruby/object:Gem::Dependency
+  name: ransack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.2
 description: A terminal based todo application for creating todo items. Adding tags
-  makes for an easy way to group and search for related items.
+  makes for an easy way to group and search for related items. Create additional notes
+  for a todo item as new related information comes up
 email:
 - lovell.mcilwain@gmail.com
 executables: