list-tool 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 34ece5f2e12c07abd8d89e3487fd5b2a38aedb36
-  data.tar.gz: 32586be177d6ff874d2a70d5110f5253ec1c8d6c
+  metadata.gz: e54d09b832771129aff1a928f60b94fbc1d5f17a
+  data.tar.gz: 2708ff9a0124406e76d06f7869cafd0bc588b1ef
 SHA512:
-  metadata.gz: c82e5dd20dbf585787b50d88b306bfc8dc6a4f265b225624e1f7e94e19515d67c74bbb4fb40f9f7d8dbfd6b738561698adcd52502394f90475e97690f6c8c218
-  data.tar.gz: 5e975d2ddf492cdbdd531d3feae2167462790764b12c61c7ba833a894ddd788c5dca3591437ba4c47d1f46351aa0d854fcd7b993acb67d829a2cab70d85d85f0
+  metadata.gz: e5ab52d6c9a250a70317fb8653b639c64ee861c444aba11998cdccab69021031e0181d8b4ee2eaae88fca83690cd11da8c841d63130a9e059d23025f9688f4fb
+  data.tar.gz: b2fdbd71cb43fa0961d30ae2052941392a5e4ca5f06211f2752eabcae08cf010a7883301ad1357e22c39fd8f0dbefc355c5285292fc8a45542927aaa6711f21c

data/README.md

@@ -1,22 +1,84 @@
 # ListTool
 
-This gem may be used to manage lists of text strings (todos, for example) in your app or in console
+This gem may be used to manage lists of text strings (todos, for example) in your ruby application or in a console (honestly, generally in a console).
 
-## In app
+## INSTALLATION
 
-In your app do this:
+To install this gem write `gem install list-tool`
 
-    require 'list-tool'
+## IN RUBY APPLICATIONS
 
-    ...
+Require list-tool with `require 'list_tool'` command
 
-    lister = Lister.new
+#### Creation
 
-I'll describe later how to work with it
+    lister = Lister.new # creates empty list
 
-## In console
+    hash = {
+      "default" => 0, # optional
+      "lists" => [ 
+        {
+          "name" => "New list",
+          "items" => [ {"text" => "item1"}, {"text" => "item2"} ]
+        }
+      ]
+    }
+    lister = Lister.from_hash(hash) # creates list from given hash
+                                    # (for example, if you have already parsed json)
 
-Also gem provides console tool named 'clt' ('console list tool'), which allows you to manage lists in console.
+    lister = Lister.from_json( json_string ) # json document must have same
+                                             # structure, as that hash above
+
+#### Saving/loading data
+
+    lister.load ( '/path/to/data.json' ) # reads data from json file
+    lister.save( '/path/to/data.json' )  # saves it's data as json
+
+#### General methods
+
+    lister.lists # => { 'todolist' => 3, 'wishlist' => 2 }, digits are numbers 
+                 # of items in list
+    lister.list(list_index=nil) # => {name: 'list_name', items: ['item1', 'item2']}
+
+For **#list** method, if list index not specified, it will return contents of default list.
+
+#### List management methods
+
+    lister.add_list('name')
+    lister.add_list( {'name'=>'todolist', 'items'=> [{'text'=>'item1'}])
+    lister.rename_list(list_index, new_name)
+    lister.delete_list(list_index)
+    lister.clear_list(list_index)
+    lister.set_default_list(list_index)
+    lister.move_list(list_index, :up) # or :down. moves list in lists list
+
+#### Item management methods
+
+    lister.add_item(item_text, {list: 2}) # 2 is an example list index here
+    lister.change_item(item_index, new_text, {list: 2})
+    lister.delete_item(item_index, {list: 2})
+    lister.move_item(item_index, :up, {list: 2})
+
+You can omit {list: list_index} argument, if so commands will affect default list.
+
+#### Bonus classes
+
+You may also want to use such classes as **ListTool::List**, **ListTool::Item** and **ListTool::Data**.
+
+List class responds to all item management methods (**\*\_item**) and few others, like **#clear!**, **#rename**, **#each** (returns each Item) and **#to_json**
+
+Data class responds to all list management methods (**\*\_list**) and also has **#to_json** and **#each** (returns each list) methods.
+
+#### Errors
+
+- all lister.\*_item methods return nil 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
+
+## IN CONSOLE
+
+This gem provides console tool named '**clt**' ('console list tool'), which allows you to manage lists in console.
 
     USAGE: clt COMMAND [OPTIONS]
 
@@ -33,12 +95,16 @@ Also gem provides console tool named 'clt' ('console list tool'), which allows y
        -h,  --help      Print this message
        -v,  --version     Print version
 
-clt keeps it's data file in ~/.clt
+clt keeps it's data in **~/.clt/data.json**
 
-## Notes
+## NOTES
 
 Note that this is my first gem and also my first rspec experiance.
 
-## Contacts
+## CONTACTS
 
 You can contact me via email: vizvamitra@gmail.com
+
+I'll be happy to get your feedback on this tool.
+
+Dmitrii Krasnov

data/Rakefile

@@ -1 +1,7 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/list_tool/item.rb

@@ -1,25 +1,21 @@
 module ListTool
 
   class Item
-    attr_reader :text
+    attr_accessor :text
 
     def initialize arg
       if arg.is_a?(String)
-        @text = arg.gsub('"', "'")
+        @text = arg
       elsif arg.is_a?(Hash)
         raise(ArgumentError, "item text not found in given hash") unless arg['text'].is_a?(String)
-        @text = arg["text"].gsub('"', "'")
+        @text = arg["text"]
       else
         raise(ArgumentError, "argument expected to be Hash or String, #{arg.class} given")
       end
     end
 
-    def text= new_text
-      @text = new_text.gsub('"', "'")
-    end
-
     def to_json
-      "{\"text\":\"#{@text}\"}"
+      "{\"text\":\"#{@text.gsub('"', '\"')}\"}"
     end
 
   end

data/lib/list_tool/list.rb

@@ -7,12 +7,12 @@ module ListTool
 
     def initialize(arg=nil)
       if arg.respond_to?(:to_str)
-        @name = arg.gsub('"', "'")
+        @name = arg
         @items = []
       elsif arg.is_a?(Hash)
         prepare_data(arg)
 
-        @name = arg['name'].gsub('"', "'")
+        @name = arg['name']
 
         @items = []
         arg['items'].each do |item|
@@ -30,12 +30,12 @@ module ListTool
     def rename str
       raise ArgumentError, 'string expected' unless str.is_a?(String)
       old_name = @name
-      @name = str.gsub('"', "'")
+      @name = str
       old_name
     end
 
     def to_json
-      json = "{\"name\":\"#{@name}\",\"items\":["
+      json = "{\"name\":\"#{@name.gsub('"', '\"')}\",\"items\":["
       @items.each do |item|
         json += item.to_json
         json += ',' unless item == @items.last

data/lib/list_tool/lister.rb

@@ -32,9 +32,7 @@ module ListTool
 
     def lists
       out = {}
-      @data.each do |list|
-        out[list.name] = list.items.count
-      end
+      @data.each { |list| out[list.name] = list.items.count }
       out
     end
 
@@ -48,9 +46,7 @@ module ListTool
             end
 
       out = {name: list.name, items: []}
-      list.items.each do |item|
-        out[:items] << item.text
-      end
+      list.items.each { |item| out[:items] << item.text }
       out
     end
 

data/lib/list_tool/version.rb

@@ -1,3 +1,3 @@
 module ListTool
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

data/spec/list_tool/item_spec.rb

@@ -37,12 +37,10 @@ describe ListTool::Item do
     it 'returns correct json' do
       expect(item.to_json).to eq "{\"text\":\"item1\"}"
     end
-  end
 
-  describe '#text=' do
-    it 'substitutes " with \'' do
-      item.text = 'text with ""'
-      expect(item.text).to eq "text with ''"
+    it 'substitutes " with \"' do
+      item = ListTool::Item.new('text with ""')
+      expect(item.to_json).to eq '{"text":"text with \"\""}'
     end
   end
 

data/spec/list_tool/list_spec.rb

@@ -216,6 +216,11 @@ describe ListTool::List do
       json_str = "{\"name\":\"Todolist\",\"items\":[{\"text\":\"item1\"},{\"text\":\"item2\"}]}"
       expect(list.to_json).to eq json_str
     end
+
+    it 'substitutes " with \"' do
+      list = ListTool::List.new({"name" => 'name with ""', "items" => []})
+      expect(list.to_json).to eq '{"name":"name with \"\"","items":[]}'
+    end
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: list-tool
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Dmitrii Krasnov
@@ -184,7 +184,7 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: list-tool-1.0.1
+summary: list-tool-1.0.2
 test_files:
 - spec/fixtures/data.json
 - spec/list_tool/app/commands/add_item_command_spec.rb