grocery_list 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c08af85be634afbb4f912332746152da9d682304
+  data.tar.gz: f3603ba95a08980c9c901a50b5d276b6cf7af355
+SHA512:
+  metadata.gz: 9fac06fe431c682442997a80b4a726777c90525cabba030070717f13261fcc7d52423820b068105a084911cc4f2c92c1a58015f11c3e1b1a236a3e620e77a1cc
+  data.tar.gz: 38c6fe94ca1c7900ebf7c2c905b94505a5bab775cb35567303e5d769222e1c8f9a93831e5d6a58e05af454f03649fc1dd28d443af59ac3f8f8ec9eba3c6459c0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+tags
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in grocery_list.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Charles-P. Clermont
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,53 @@
+# Grocery-list
+Turn your json, csv, md, or strings into grocery lists that you can
+then search for.
+
+## Example usage
+```ruby
+require 'grocery_list'
+
+GroceryList.search_all('spam, eggs, bacon')
+#=> opens 1 tab/item on iga.net sorted by price ascending
+```
+
+## Installation
+```bash
+gem install grocery_list
+```
+
+## Formats
+### Strings
+  Strings are expected to be split by commas.
+
+```ruby
+  "spam, egg, bacon, maple syrup" #=> valid
+  "spam, egg, \nbacon, maple syrup" #=> invalid
+```
+
+### JSON
+  Just pass in an array of strings and you're golden.
+
+```ruby
+  '["spam", "egg", "bacon", "maple syrup"]'
+```
+
+### Markdown File
+  Every list items identified by a ` *` is considered an item. Every
+line which doesn't respect this isn't.
+
+```markdown
+# Grocery List
+ * Spam
+ * Eggs
+ * Bacon
+ * Maple syrup
+
+Anything else isn't considered an item.
+```
+
+## To do
+  * [ ] Implement more searchers? I have IGA.net working in Montreal;
+Could be extended?
+
+## License
+MIT

data/example.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+require 'grocery_list'
+
+# make sure arguments are ok
+unless ARGV.length <= 2 && ARGV.length > 0
+  puts "Wrong number of arguments"
+  puts "Usage: example.rb [source] [:sort-option]"
+  exit
+end
+
+# parse input arguments
+input_source = ARGV[0]
+sort_option = ARGV[1].to_sym unless ARGV.length < 2
+
+# search
+GroceryList.search_all(input_source, GroceryList::IGASearcher.new(sort_option || :priceAsc))

data/grocery_list.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'grocery_list/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "grocery_list"
+  spec.version       = GroceryList::VERSION
+  spec.authors       = ["Charles-P. Clermont"]
+  spec.email         = ["charles.pclermont@gmail.com"]
+  spec.summary       = %q{Turn your json, csv, md, or strings into grocery lists that you can then search for.}
+  # spec.description   = %q{}
+  spec.homepage      = "https://github.com/charlespwd/grocery-list"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "launchy", "~> 2.4"
+  spec.add_development_dependency "bundler", "~> 1.5"
+end

data/lib/grocery_list/item.rb

@@ -0,0 +1,14 @@
+module GroceryList
+  class Item
+    attr_reader :item_name
+
+    def initialize(item_name)
+      @item_name = item_name
+    end
+
+    def ==(y)
+      y.item_name == @item_name
+    end
+  end
+end
+

data/lib/grocery_list/item_parser.rb

@@ -0,0 +1,11 @@
+module GroceryList
+  class AbstractItemParser
+    def self.read(string)
+      raise NotImplementedError
+    end
+  end
+end
+
+require 'grocery_list/item_parsers/string_item_parser'
+require 'grocery_list/item_parsers/file_item_parser'
+require 'grocery_list/item_parsers/json_item_parser'

data/lib/grocery_list/item_parsers/file_item_parser.rb

@@ -0,0 +1,32 @@
+module GroceryList
+  class FileItemParser < AbstractItemParser
+    class << self
+      def read(file_path)
+        raise ArgumentError unless file_path.is_a? String
+        file = IO.read(file_path)
+        items_from_file(file)
+      end
+
+      private
+      def items_from_file(file)
+        file.split("\n").map do |line|
+          line_to_item(line)
+        end.select do |item|
+          item.is_a? Item
+        end
+      end
+
+      def line_to_item(line)
+        Item.new(item_name(line)) if is_valid_item(line)
+      end
+
+      def is_valid_item(line)
+        line.start_with? " *"
+      end
+
+      def item_name(line)
+        line[2..-1].strip
+      end
+    end
+  end
+end

data/lib/grocery_list/item_parsers/json_item_parser.rb

@@ -0,0 +1,14 @@
+require 'json'
+
+module GroceryList
+  class JsonItemParser < AbstractItemParser
+    def self.read(json_string)
+      parsed_json = JSON.parse(json_string)
+      raise ArgumentError unless parsed_json.is_a? Array
+
+      parsed_json.map do |item|
+        Item.new(item.strip)
+      end
+    end
+  end
+end

data/lib/grocery_list/item_parsers/string_item_parser.rb

@@ -0,0 +1,8 @@
+module GroceryList
+  class StringItemParser < AbstractItemParser
+    def self.read(string)
+      raise ArgumentError unless string.is_a? String
+      string.split(',').map {|s| Item.new(s.strip)}
+    end
+  end
+end

data/lib/grocery_list/item_searcher.rb

@@ -0,0 +1,9 @@
+module GroceryList
+  class AbstractSearcher
+    def search(item)
+      raise NotImplementedError
+    end
+  end
+end
+
+require 'grocery_list/item_searchers/iga_item_searcher'

data/lib/grocery_list/item_searchers/iga_item_searcher.rb

@@ -0,0 +1,46 @@
+module GroceryList
+  class IGASearcher < AbstractSearcher
+    attr :search_options
+
+    @@search_url = "http://magasin.iga.net/Search/BasicSearch.aspx?Search="
+
+    @@valid_options = [
+      :priceDesc,
+      :priceAsc,
+      :DisplayNameDesc,
+      :DisplayNameAsc,
+    ]
+
+    def initialize(search_option = :priceAsc)
+      @search_options = search_option
+    end
+
+    def search(item)
+      raise ArgumentError, "#{item} isn't an Item" unless item.is_a? Item
+      Launchy.open url(item.item_name)
+    end
+
+    def search_options=(option = :priceAsc)
+      raise ArgumentError, "#{option} is an invalid option" unless @@valid_options.include? option
+      @search_options = option
+    end
+
+    def search_options
+      @search_options
+    end
+
+    private
+    def url(item_name)
+      "#{@@search_url}#{url_encode(item_name)}#{encoded_options}"
+    end
+
+    def url_encode(str)
+      str.gsub(/ /, '%20')
+    end
+
+    def encoded_options
+      @search_options ? "&sort=#{@search_options.to_s}" : ""
+    end
+  end
+end
+

data/lib/grocery_list/version.rb

@@ -0,0 +1,3 @@
+module GroceryList
+  VERSION = "0.0.1"
+end

data/lib/grocery_list.rb

@@ -0,0 +1,50 @@
+require 'launchy'
+
+module GroceryList
+  class << self
+    attr_reader :items, :searcher
+
+    @@source_type_tests = {
+      :is_json_array? => ->(s) { s.start_with? '[' },
+      :is_a_path?     => ->(s) { s.is_a? String and File.readable? s },
+      :is_a_string?   => ->(s) { s.is_a? String and not File.readable? s},
+    }
+    @@searchers = {
+      :is_json_array? => ->(s) { JsonItemParser.read(s) },
+      :is_a_path?     => ->(s) { FileItemParser.read(s) },
+      :is_a_string?   => ->(s) { StringItemParser.read(s) },
+    }
+
+    def search_all(items_source, searcher = IGASearcher.new)
+      validate_input(items_source, searcher)
+      @items.each do |item|
+        @searcher.search(item)
+      end
+    end
+
+    private
+    def validate_input(items_source, searcher)
+      raise ArgumentError, "isn't a valid source" unless is_valid_source? items_source
+      raise ArgumentError, "searcher isn't a AbstractSearcher" unless searcher.is_a? AbstractSearcher
+      @items = items_from_source(items_source)
+      @searcher = searcher
+    end
+
+    def items_from_source(items_source)
+      @@source_type_tests.each do |key, test|
+        if test.call(items_source)
+          return @@searchers[key].call(items_source)
+        end
+      end
+    end
+
+    def is_valid_source?(items_source)
+      @@source_type_tests.values.any? {|f| f.call(items_source)}
+    end
+  end
+end
+
+require 'grocery_list/item'
+require 'grocery_list/item_parser'
+require 'grocery_list/item_searcher'
+require "grocery_list/version"

data/spec/fixtures/list_test.md

@@ -0,0 +1,7 @@
+# My test list
+
+ * bread
+ * philadelphia
+ * bagel all dressed
+
+Anything else shoudn't be parsed

data/spec/lib/groceries_spec.rb

@@ -0,0 +1,42 @@
+require 'grocery_list'
+require './spec/stubs/IGASearcherStub'
+
+ITEMS_AS_STRING = "bread, philadelphia, bagel all dressed"
+ITEMS_AS_JSON = '["bread", "philadelphia", "bagel all dressed"]'
+
+describe GroceryList do
+  it "should accept a list as a string and a searcher" do
+    expect { GroceryList.search_all(ITEMS_AS_STRING, IGASearcherStub.new) }.to_not raise_error
+  end
+
+  it "should accept a list as a path and a searcher" do
+    expect { GroceryList.search_all('./spec/fixtures/list_test.md', IGASearcherStub.new) }.to_not raise_error
+  end
+
+  it "should accept a list as a json string and a searcher" do
+    expect { GroceryList.search_all(ITEMS_AS_JSON, IGASearcherStub.new) }.to_not raise_error
+  end
+
+  it "should throw an error if path isn't readble or if not a string" do
+    expect {GroceryList.search_all('./lib', IGASearcherStub.new)}.to raise_error
+    expect {GroceryList.search_all(5, IGASearcherStub.new)}.to raise_error
+  end
+
+  it "should not throw an error if empty string is provided" do
+    expect {GroceryList.search_all('', IGASearcherStub.new)}.to_not raise_error
+  end
+
+  it "should not throw an error if the searcher isn't a searcher" do
+    expect {GroceryList.search_all('', 'IGASearcherStub')}.to raise_error
+  end
+
+  it "should search all items" do
+    expect { GroceryList.search_all('./spec/fixtures/list_test.md', IGASearcherStub.new) }.to_not raise_error
+  end
+
+  it "should search all items sorted by priceAsc" do
+    searcher = IGASearcherStub.new
+    searcher.search_options = :priceAsc
+    expect { GroceryList.search_all('./spec/fixtures/list_test.md', searcher) }.to_not raise_error
+  end
+end

data/spec/lib/item_reader_spec.rb

@@ -0,0 +1,52 @@
+require 'grocery_list'
+
+ITEMS_AS_STRING = "bread, philadelphia, bagel all dressed"
+ITEMS_AS_JSON = '["bread", "philadelphia", "bagel all dressed"]'
+
+describe GroceryList::AbstractItemParser do
+  let(:reader) { GroceryList::AbstractItemParser }
+
+  it "should have an unimplemented read method" do
+    expect{ reader.read }.to raise_error
+  end
+end
+
+describe GroceryList::StringItemParser do
+  let(:reader) { GroceryList::StringItemParser }
+
+  it "should turn a string into an array of item" do
+    items = reader.read(ITEMS_AS_STRING)
+    expect(items.is_a? Array).to eql(true)
+  end
+end
+
+describe GroceryList::FileItemParser do
+  let(:reader) { GroceryList::FileItemParser }
+
+  it "should raise an error if no files are found" do
+    expect{ reader.read('null') }.to raise_error
+    expect{ reader.read('./spec/lib/searcher_spec.rb') }.to_not raise_error
+  end
+
+  it "should only read lines prefixed by a star" do
+    expected_result = GroceryList::StringItemParser.read(ITEMS_AS_STRING)
+
+    expect(reader.read('./spec/fixtures/list_test.md')).to eq(expected_result)
+  end
+end
+
+describe GroceryList::JsonItemParser do
+  let(:reader) { GroceryList::JsonItemParser }
+
+  it "should raise an error if json isn't an array" do
+    expect{ reader.read(42) }.to raise_error
+    expect{ reader.read('null') }.to raise_error
+    expect{ reader.read(ITEMS_AS_JSON) }.to_not raise_error
+  end
+
+  it "should turn parsed array into an array of items" do
+    expected_result = GroceryList::StringItemParser.read(ITEMS_AS_STRING)
+
+    expect(reader.read(ITEMS_AS_JSON)).to eq(expected_result)
+  end
+end

data/spec/lib/searcher_spec.rb

@@ -0,0 +1,26 @@
+require "grocery_list"
+require "./spec/stubs/IGASearcherStub"
+
+describe GroceryList::AbstractSearcher do
+  it "should have a search method that is not implemented" do
+    searcher = GroceryList::AbstractSearcher.new
+    expect{ searcher.search("") }.to raise_error
+  end
+end
+
+describe GroceryList::IGASearcher do
+  it "should have a search method that is implemented" do
+    searcher = GroceryList::IGASearcher.new
+    expect{ searcher.search("") }.to raise_error
+    # expect{ searcher.search(Item.new("pain")) }.to_not raise_error
+  end
+
+  it "should throw an error if trying to set an invalid option" do
+    searcher = IGASearcherStub.new
+    expect { searcher.search_options = :invalid }.to raise_error
+    expect { searcher.search_options = :priceAsc }.to_not raise_error
+    expect { searcher.search_options = :priceDesc }.to_not raise_error
+    expect { searcher.search_options = :DisplayNameAsc }.to_not raise_error
+    expect { searcher.search_options = :DisplayNameDesc }.to_not raise_error
+  end
+end

data/spec/stubs/IGASearcherStub.rb

@@ -0,0 +1,8 @@
+require "grocery_list"
+
+class IGASearcherStub < GroceryList::IGASearcher
+  def search(item)
+    raise ArgumentError, "#{item} isn't an Item" unless item.is_a? GroceryList::Item
+    puts url(item.item_name)
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: grocery_list
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Charles-P. Clermont
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: launchy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+description: 
+email:
+- charles.pclermont@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- example.rb
+- grocery_list.gemspec
+- lib/grocery_list.rb
+- lib/grocery_list/item.rb
+- lib/grocery_list/item_parser.rb
+- lib/grocery_list/item_parsers/file_item_parser.rb
+- lib/grocery_list/item_parsers/json_item_parser.rb
+- lib/grocery_list/item_parsers/string_item_parser.rb
+- lib/grocery_list/item_searcher.rb
+- lib/grocery_list/item_searchers/iga_item_searcher.rb
+- lib/grocery_list/version.rb
+- spec/fixtures/list_test.md
+- spec/lib/groceries_spec.rb
+- spec/lib/item_reader_spec.rb
+- spec/lib/searcher_spec.rb
+- spec/stubs/IGASearcherStub.rb
+homepage: https://github.com/charlespwd/grocery-list
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.3.0
+signing_key: 
+specification_version: 4
+summary: Turn your json, csv, md, or strings into grocery lists that you can then
+  search for.
+test_files:
+- spec/fixtures/list_test.md
+- spec/lib/groceries_spec.rb
+- spec/lib/item_reader_spec.rb
+- spec/lib/searcher_spec.rb
+- spec/stubs/IGASearcherStub.rb