list-tool 1.0.3 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c69589b5f4855ec2cd106e4ca28da01ca9b1652a
-  data.tar.gz: f0d3bfbe5f5461158b742da2b3d78dcbee9a9b3c
+  metadata.gz: be84730bfcdb5b3ac055f621aa41cc3ebc931806
+  data.tar.gz: 8aca87d46e3b310f25e4e1a506af4327e1f5e643
 SHA512:
-  metadata.gz: 1e42225bf98637b797789690784b886be3ad17d6ca88625b9896bfd144ec439873cdc5281882319b6dde1b0f8b36374a5c6c9ade3a53a98e1832ec2b0bea7b21
-  data.tar.gz: 433cec2c79327d00fb6605baedc3f03759be0f7b942a770f91d8db3a2c182840564d49f50421977825d52af86a672f43f0ec05a9d0f011d0842975ce62fcf49d
+  metadata.gz: fa3eb60d41ef20b9234efdcc728a48840e50d671270b8b301ee93c266050448b2114d94f8d96a4608090e0eb4b10ab802d2c033110a8d40580adb318a878421a
+  data.tar.gz: 8a4696d902bf523bbaf66a5a4db2080cc24542839175b842601bc61074b39944e29ccbd66649f3bb9c8697daa5b9e7b18136e434791f952c29922f904a425336

data/README.md

@@ -39,8 +39,10 @@ Require list-tool with `require 'list_tool'` command
     lister.lists # => { 'todolist' => 3, 'wishlist' => 2 }
                  # (digits for item quantitiy in a list)
     lister.list(list_index=nil) # => {name: 'list_name', items: ['item1', 'item2']}
+    lister.default_list # => {name: 'list_name', items: ['item1', 'item2']}
 
 For **#list** method, if list index is not specified, it will return contents of default list.
+For **#default_list** method, if default list is not set, it will return nil.
 
 #### List management methods
 
@@ -71,7 +73,7 @@ ListerData class responds to all list management methods (**\*\_list**) and also
 
 #### Errors
 
-- all lister.\*_item methods return nil if list was not found.
+- all lister.\*_item methods raise **ListTool::ListNotFoundError** if list was not found.
 - lister.list and lister.\*_list methods raise **ListTool::NoDefaultListError** if list index is not specified and default list is not set
 - #save and #load methods may return **ListTool::FileAccessError** or **ListTool::FileNotFoundError**
 - other errors are generally **ArgumentError** s
@@ -90,6 +92,7 @@ This gem provides console tool named '**clt**' ('console list tool'), which allo
         al, add-list NAME             Create list with NAME
         rl, rename-list LIST, NAME    Set LIST name to NAME
         dl, del-list LIST             Delete given LIST
+        cl, clear-list LIST           Clear given LIST
         sl, show-lists                Print list of existing lists
         u,  use LIST                  Set default list
        -h,  --help                    Print this message

data/lib/list_tool/app/commands/add_item_command.rb

@@ -1,38 +1,35 @@
 module ListTool
   module App
 
-    class AddItemCommand
+    class AddItemCommand < Command
+      class << self
 
-      def self.match? arg
-        ['a', 'add-item'].include? arg
-      end
+        def match? arg
+          ['a', 'add-item'].include? arg
+        end
 
-      def self.parse argv
-        raise ArgumentError, "expected argument to be an array, #{argv.class} given" unless argv.is_a? Array
+        def parse argv
+          fail_if_not_an_array(argv)
 
-        item, list = argv.shift(2)
-        raise ArgumentError, 'item text not specified' if item.nil?
+          item, list = argv.shift(2)
+          ensure_existence_of('item text' => item)
 
-        out = {text: item}
-        
-        if list
-          out[:list] = Integer(list) - 1 rescue raise(ArgumentError, 'list number must be an integer')
-          raise ArgumentError, "list number can't be less than 1" if out[:list] < 0
+          out = {text: item}
+          out[:list] = parse_list_number(list) if list
+          out
         end
 
-        out
-      end
+        def execute options, lister
+          args = [ options.delete(:text) ]
+          args << options if options[:list]
+          raise(ListNotFoundError, 'no list with given number') if lister.add_item(*args).nil?
+        end
 
-      def self.execute options, lister
-        args = [ options.delete(:text) ]
-        args << options if options[:list]
-        raise(ListNotFoundError, 'no list with given number') if lister.add_item(*args).nil?
-      end
+        def help
+          "  a,  add-item TEXT [LIST]\tAdd item with TEXT to given or default list"
+        end
 
-      def self.help
-        "  a,  add-item TEXT [LIST]\tAdd item with TEXT to given or default list"
       end
-
     end
 
   end

data/lib/list_tool/app/commands/add_list_command.rb

@@ -1,29 +1,31 @@
 module ListTool
   module App
 
-    class AddListCommand
+    class AddListCommand < Command
+      class << self
 
-      def self.match? arg
-        ['al', 'add-list'].include? arg
-      end
+        def match? arg
+          ['al', 'add-list'].include? arg
+        end
 
-      def self.parse argv
-        raise ArgumentError, "expected argument to be an array, #{argv.class} given" unless argv.is_a? Array
-        name = argv.shift
-        raise ArgumentError, 'list name not specified' if name.nil?
-        raise ArgumentError, 'name is not a string' unless name.is_a? String
+        def parse argv
+          fail_if_not_an_array(argv)
 
-        {name: name}
-      end
+          name = argv.shift
+          ensure_existence_of("list name" => name)
 
-      def self.execute options, lister
-        raise(RuntimeError, "list creation failed") if lister.add_list(options[:name]).nil?
-      end
+          {name: name}
+        end
 
-      def self.help
-        "  al, add-list NAME\t\tCreate list with NAME"
-      end
+        def execute options, lister
+          raise(RuntimeError, "list creation failed") if lister.add_list(options[:name]).nil?
+        end
+
+        def help
+          "  al, add-list NAME\t\tCreate list with NAME"
+        end
 
+      end
     end
 
   end

data/lib/list_tool/app/commands/clear_list_command.rb

@@ -0,0 +1,31 @@
+module ListTool
+  module App
+
+    class ClearListCommand < Command
+      class << self
+
+        def match? arg
+          ['cl', 'clear-list'].include? arg
+        end
+
+        def parse argv
+          fail_if_not_an_array(argv)
+          
+          list = argv.shift
+
+          {list: parse_list_number!(list)}
+        end
+
+        def execute options, lister
+          raise(ListNotFoundError, 'no list with given number') if lister.clear_list(options[:list]).nil?
+        end
+
+        def help
+          "  cl, clear-list LIST\t\tClear given LIST"
+        end
+
+      end
+    end
+
+  end
+end

data/lib/list_tool/app/commands/command.rb

@@ -0,0 +1,50 @@
+module ListTool
+  module App
+
+    class Command
+
+      class << self
+
+        def parse_number str, name
+          index = Integer(str) - 1 rescue raise(ArgumentError, "#{name} number must be an integer")
+          raise ArgumentError, "#{name} number can't be less than 1" if index < 0
+          index
+        end
+
+
+        def parse_item_number str
+          parse_number(str, "item")
+        end
+
+        def parse_list_number str
+          parse_number(str, "list")
+        end
+
+
+        def parse_item_number! str
+          raise ArgumentError, 'item number not specified' if str.nil?
+          parse_item_number(str)
+        end
+
+        def parse_list_number! str
+          raise ArgumentError, 'list number not specified' if str.nil?
+          parse_list_number(str)
+        end
+
+
+        def ensure_existence_of hash
+          hash.each do |key, value|
+            raise ArgumentError, "#{key} not specified" if value.nil?
+          end
+        end
+
+        def fail_if_not_an_array arg
+          raise ArgumentError, "expected argument to be an array, #{arg.class} given" unless arg.is_a? Array
+        end
+
+      end
+
+    end
+
+  end
+end

data/lib/list_tool/app/commands/delete_item_command.rb

@@ -1,38 +1,34 @@
 module ListTool
   module App
 
-    class DeleteItemCommand
+    class DeleteItemCommand < Command
+      class << self
 
-      def self.match? arg
-        ['d', 'del-item'].include? arg
-      end
+        def match? arg
+          ['d', 'del-item'].include? arg
+        end
 
-      def self.parse argv
-        raise ArgumentError, "expected argument to be an array, #{argv.class} given" unless argv.is_a? Array
+        def parse argv
+          fail_if_not_an_array(argv)
 
-        item, list = argv.shift(2)
-        raise ArgumentError, 'item number not specified' if item.nil?
+          item, list = argv.shift(2)
 
-        out = {item: Integer(item) - 1} rescue raise(ArgumentError, 'item number must be an integer')
-        
-        if list
-          out[:list] = Integer(list) - 1 rescue raise(ArgumentError, 'list number must be an integer')
-          raise ArgumentError, "list number can't be less than 1" if out[:list] < 0
+          out = { item: parse_item_number!(item) } 
+          out[:list] = parse_list_number(list) if list
+          out
         end
 
-        out
-      end
+        def execute options, lister
+          args = [ options[:item] ]
+          args << {list: options[:list]} if options[:list]
+          raise(ListNotFoundError, 'no list with given number') if lister.delete_item(*args).nil?
+        end
 
-      def self.execute options, lister
-        args = [ options[:item] ]
-        args << {list: options[:list]} if options[:list]
-        raise(ListNotFoundError, 'no list with given number') if lister.delete_item(*args).nil?
-      end
+        def help
+          "  d,  del-item ITEM [LIST]\tDelete ITEM from given or default list"
+        end
 
-      def self.help
-        "  d,  del-item ITEM [LIST]\tDelete ITEM from given or default list"
       end
-
     end
 
   end

data/lib/list_tool/app/commands/delete_list_command.rb

@@ -1,31 +1,30 @@
 module ListTool
   module App
 
-    class DeleteListCommand
+    class DeleteListCommand < Command
+      class << self
 
-      def self.match? arg
-        ['dl', 'del-list'].include? arg
-      end
+        def match? arg
+          ['dl', 'del-list'].include? arg
+        end
 
-      def self.parse argv
-        raise ArgumentError, "expected argument to be an array, #{argv.class} given" unless argv.is_a? Array
-        list = argv.shift
-        raise ArgumentError, 'list number not specified' if list.nil?
-        
-        list = Integer(list) - 1 rescue raise(ArgumentError, 'list number must be an integer')
-        raise ArgumentError, "list number can't be less than 1" if list < 0
+        def parse argv
+          fail_if_not_an_array(argv)
+          
+          list = argv.shift
+          
+          {list: parse_list_number!(list)}
+        end
 
-        {list: list}
-      end
+        def execute options, lister
+          raise(ListNotFoundError, 'no list with given number') if lister.delete_list(options[:list]).nil?
+        end
 
-      def self.execute options, lister
-        raise(ListNotFoundError, 'no list with given number') if lister.delete_list(options[:list]).nil?
-      end
+        def help
+          "  dl, del-list LIST\t\tDelete given LIST"
+        end
 
-      def self.help
-        "  dl, del-list LIST\t\tDelete given LIST"
       end
-
     end
 
   end

data/lib/list_tool/app/commands/help_command.rb

@@ -1,24 +1,26 @@
 module ListTool
   module App
 
-    class HelpCommand
+    class HelpCommand < Command
+      class << self
 
-      def self.match? arg
-        ['h', '-h', 'help', '--help'].include? arg
-      end
+        def match? arg
+          ['h', '-h', 'help', '--help'].include? arg
+        end
 
-      def self.parse argv
-        {}
-      end
+        def parse argv
+          {}
+        end
 
-      def self.execute options, lister
-        Printer.print_usage
-      end
+        def execute options, lister
+          Printer.print_usage
+        end
 
-      def self.help
-        " -h,  --help\t\t\tPrint this message"
-      end
+        def help
+          " -h,  --help\t\t\tPrint this message"
+        end
 
+      end
     end
   end
 end

data/lib/list_tool/app/commands/rename_list_command.rb

@@ -1,33 +1,32 @@
 module ListTool
   module App
 
-    class RenameListCommand
+    class RenameListCommand < Command
+      class << self
+
+        def match? arg
+          ['rl', 'rename-list'].include? arg
+        end
+
+        def parse argv
+          fail_if_not_an_array(argv)
+          
+          list, name = argv.shift(2)
+          ensure_existence_of('new name' => name)
+          
+          { name: name, list: parse_list_number!(list) }
+        end
+
+        def execute options, lister
+          args = [ options[:list], options[:name] ]
+          raise(ListNotFoundError, 'no list with given number') if lister.rename_list(*args).nil?
+        end
+
+        def help
+          "  rl, rename-list LIST, NAME\tSet LIST name to NAME"
+        end
 
-      def self.match? arg
-        ['rl', 'rename-list'].include? arg
       end
-
-      def self.parse argv
-        raise ArgumentError, "expected argument to be an array, #{argv.class} given" unless argv.is_a? Array
-        list, name = argv.shift(2)
-        raise ArgumentError, 'list number not specified' if list.nil?
-        raise ArgumentError, 'new name not specified' if name.nil?
-        
-        list = Integer(list) - 1 rescue raise(ArgumentError, 'list number must be an integer')
-        raise ArgumentError, "list number can't be less than 1" if list < 0
-
-        {name: name, list: list}
-      end
-
-      def self.execute options, lister
-        args = [ options[:list], options[:name] ]
-        raise(ListNotFoundError, 'no list with given number') if lister.rename_list(*args).nil?
-      end
-
-      def self.help
-        "  rl, rename-list LIST, NAME\tSet LIST name to NAME"
-      end
-
     end
 
   end

data/lib/list_tool/app/commands/replace_item_command.rb

@@ -1,33 +1,32 @@
 module ListTool
   module App
 
-    class ReplaceItemCommand
+    class ReplaceItemCommand < Command
+      class << self
 
-      def self.match? arg
-        ['r', 'replace-item'].include? arg
-      end
+        def match? arg
+          ['r', 'replace-item'].include? arg
+        end
 
-      def self.parse argv
-        raise ArgumentError, "expected argument to be an array, #{argv.class} given" unless argv.is_a? Array
-        item, name = argv.shift(2)
-        raise ArgumentError, 'item number not specified' if item.nil?
-        raise ArgumentError, 'new name not specified' if name.nil?
-        
-        item = Integer(item) - 1 rescue raise(ArgumentError, 'item number must be an integer')
-        raise ArgumentError, "item number can't be less than 1" if item < 0
+        def parse argv
+          fail_if_not_an_array(argv)
 
-        {name: name, item: item}
-      end
+          item, name = argv.shift(2)
+          ensure_existence_of('new name' => name)
 
-      def self.execute options, lister
-        args = [ options[:item], options[:name] ]
-        raise(ItemNotFoundError, 'no item with given number') if lister.change_item(*args).nil?
-      end
+          { name: name, item: parse_item_number!(item) }
+        end
 
-      def self.help
-        "  r,  replace-item ITEM, TEXT\tSet ITEM text to TEXT"
-      end
+        def execute options, lister
+          args = [ options[:item], options[:name] ]
+          raise(ItemNotFoundError, 'no item with given number') if lister.change_item(*args).nil?
+        end
+
+        def help
+          "  r,  replace-item ITEM, TEXT\tSet ITEM text to TEXT"
+        end
 
+      end
     end
 
   end

data/lib/list_tool/app/commands/show_items_command.rb

@@ -1,34 +1,32 @@
 module ListTool
   module App
 
-    class ShowItemsCommand
+    class ShowItemsCommand < Command
+      class << self
 
-      def self.match? arg
-        ['s', 'show-items'].include? arg
-      end
+        def match? arg
+          ['s', 'show-items'].include? arg
+        end
 
-      def self.parse argv
-        raise ArgumentError, "expected argument to be an array, #{argv.class} given" unless argv.is_a? Array
-        list = argv.shift
+        def parse argv
+          fail_if_not_an_array(argv)
+          
+          list = argv.shift
 
-        if list
-          list = Integer( list ) - 1 rescue raise(ArgumentError, 'list number must be an integer')
-          raise ArgumentError, "list number can't be less than 1" if list < 0
+          list ? {list: parse_list_number(list)} : {}
         end
 
-        list ? {list: list} : {}
-      end
+        def execute options, lister
+          items = options[:list].nil? ? lister.list() : lister.list(options[:list])
+          raise ListNotFoundError if items.nil?
+          Printer.print_items( items )
+        end
 
-      def self.execute options, lister
-        items = options[:list].nil? ? lister.list() : lister.list(options[:list])
-        raise ListNotFoundError if items.nil?
-        Printer.print_items( items )
-      end
+        def help
+          "  s,  show-items [LIST]\t\tPrint contents of default or given list"
+        end
 
-      def self.help
-        "  s,  show-items [LIST]\t\tPrint contents of default or given list"
       end
-
     end
 
   end

data/lib/list_tool/app/commands/show_lists_command.rb

@@ -1,25 +1,27 @@
 module ListTool
   module App
 
-    class ShowListsCommand
+    class ShowListsCommand < Command
+      class << self
 
-      def self.match? arg
-        ['sl', 'show-lists'].include? arg
-      end
+        def match? arg
+          ['sl', 'show-lists'].include? arg
+        end
 
-      def self.parse argv
-        {}
-      end
+        def parse argv
+          {}
+        end
 
-      def self.execute options, lister
-        lists = lister.lists
-        Printer.print_lists(lists)
-      end
+        def execute options, lister
+          lists = lister.lists
+          Printer.print_lists(lists)
+        end
 
-      def self.help
-        "  sl, show-lists\t\tPrint list of existing lists"
-      end
+        def help
+          "  sl, show-lists\t\tPrint list of existing lists"
+        end
 
+      end
     end
 
   end

data/lib/list_tool/app/commands/unknown_command.rb

@@ -1,25 +1,27 @@
 module ListTool
   module App
 
-    class UnknownCommand
+    class UnknownCommand < Command
+      class << self
 
-      def self.match? arg
-        @unknown_command = arg
-        true
-      end
+        def match? arg
+          @unknown_command = arg
+          true
+        end
 
-      def self.parse argv
-        {}
-      end
+        def parse argv
+          {}
+        end
 
-      def self.execute options, lister
-        raise UnknownCommandError, "unknown command: '#{@unknown_command}'"
-      end
+        def execute options, lister
+          raise UnknownCommandError, "unknown command: '#{@unknown_command}'"
+        end
 
-      def self.help
-        ""
-      end
+        def help
+          ""
+        end
 
+      end
     end
 
   end