goods 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bc907ce0650d82d39c2d077d63492e2ad9b1d4fa
+  data.tar.gz: 69b1b31e9bdfc828364fb7c16dda6c53545b3dfe
+SHA512:
+  metadata.gz: 783ddac11cd0e9ac7648a2dc36c8f34573ad2d5935529e91e95ffd8ed2b9d76b7aedec8fdf63818f1a713facb284270e6b4e34c3dc6d6257ddac6dc341225ada
+  data.tar.gz: 37c18feb8ebe1e7f0108690ee662bb6f869726b1495277250d3fcbbf35a877200d02d3bb009777eac26800dfead0407848dcc75c97f5e8b22ebb93bdaae2a106

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Artem Pyanykh
+
+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,114 @@
+# Goods
+
+The purpose of this gem is to provide simple, yet reliable solution for parsing
+YML (Yandex Market Language) files, with clean and convenient interface,
+and a few extra capabilites, such as categories prunning.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'goods'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install goods
+
+## Usage
+
+1. **How to parse YML-catalog**:
+		
+		begin
+			catalog = Goods.from_string(xml, url, encoding)
+			[ or Goods.from_url(url, encoding) ]
+			[ or Goods.from_file(io, encoding) ]
+		rescue Goods::XML::InvalidFormatError => e
+			#do something
+		end
+	
+	* `encoding` is optional;
+	* `url` is optional when parsing string;
+		
+2. **How to iterate over offers**:
+
+		catalog.offers.each do |offer|
+			offer.id # => "some id"
+			offer.category # => <Goods::Category>
+			offer.currency # => <Goods::Currency>
+			offer.price # => 50.0 (for example)
+			etc...
+		end
+3. **How to iterate over categories**:
+		
+		catalog.categories.each do |category|
+			category.id # => "some id"
+			category.name # => "some name"
+			category.parent # => <Goods::Category> or nil
+			etc...
+		end
+		
+4. **How to iterate over currencies**:
+		
+		catalog.currencies.each do |currency|
+			currency.id # => "RUR"
+			currency.rate # => 1.00 or 30.00 or some other float
+			etc...
+		end
+		
+5. **How to get a single element from the collection**:
+
+	If you know an ID of an object, you may act like this
+	
+		(for example, let's take currencies)
+		rur = catalog.currencies.find("RUR") # => <Goods::Curency>
+		rur.rate # => 1.00
+
+6. **How to prune categories in a whole catalog**:
+		
+		catalog.prune(level_of_pruning)
+	
+	It will replace all categories with level greater than `level_of_pruning` with their parents at that level.
+	
+	What is the purpose of prunning? For example, with very deep categories structure it may be very costly in terms of performance to mirror this structure in your database. It may be sufficient to have a representation with lower level of details.	
+	
+7. **How to convert currencies and prices for a whole catalog**:
+
+		rur = catalog.currencies.find("RUR")
+		catalog.convert_currency(rur)
+		
+	It will convert all prices and change `currency` for every offer.
+	
+8. **But what's with invalid elements**:
+	
+	General validation is performed according to DTD spec., and guarantees that you will have all the fields, that you're expecting to find in a YML-catalog. However, there can be somewhat trickier inconsistencies in YML-files, like offer having non-existing category_id, or currency_id.
+	
+	All that valid (according to DTD), but defective elements are saved under `defectives` property of a collection. Each defective element has `invalid_field` property. For example:
+		
+		defectives = catalog.offers.defectives # => Array of Goods::Offer
+		defectives.first.invalid_fields # => [:category_id, :currency_id]
+9. **How can I manually validate YML-file against DTD?**:
+		
+		validator = Goods::XML::Validator.new
+		validator.valid?(xml_string) # => true or false
+		validator.error # => first validation error
+		
+10. **Is that all?**
+
+	No, it is not. For more information look at the source code.
+	
+	
+## Contributing
+
+At current time, Goods::Offer is quite incomplete, and works only with properties, that I need. Generalization of Goods::Offer is welcome!
+
+**So**:
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/goods.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'goods/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "goods"
+  spec.version       = Goods::VERSION
+  spec.authors       = ["Artem Pyanykh"]
+  spec.email         = ["artem.pyanykh@gmail.com"]
+  spec.description   = <<DESC
+  The purpose of this gem is to provide simple, yet reliable solution for parsing
+  YML (Yandex Market Language) files, with clean and convenient interface,
+  and extra capabilites, such as categories prunning.
+DESC
+  spec.summary       = %q{Simple parser for YML (Yandex Market Language) files with a few twists.}
+  spec.homepage      = "https://github.com/ArtemPyanykh/goods"
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.0.0.beta1"
+
+  spec.add_runtime_dependency "libxml-ruby"
+  spec.add_runtime_dependency "nokogiri"
+end

data/lib/goods/catalog.rb

@@ -0,0 +1,32 @@
+module Goods
+  class Catalog
+    attr_reader :categories, :currencies, :offers
+
+    def initialize(params)
+      if params[:string]
+        from_string(params[:string], params[:url], params[:encoding])
+      else
+        raise ArgumentError, "should provide either :string or :url param"
+      end
+    end
+
+    def prune(level)
+      @offers.prune_categories(level)
+      @categories.prune(level)
+    end
+
+    def convert_currency(other_currency)
+      @offers.convert_currency(other_currency)
+    end
+
+    private
+
+    def from_string(xml_string, url, encoding)
+      @xml_string = xml_string
+      @xml = XML.new(xml_string, url, encoding)
+      @categories = CategoriesList.new(@xml.categories)
+      @currencies = CurrenciesList.new(@xml.currencies)
+      @offers = OffersList.new(@categories, @currencies, @xml.offers)
+    end
+  end
+end

data/lib/goods/categories_list.rb

@@ -0,0 +1,26 @@
+module Goods
+  class CategoriesList
+    extend Container
+    container_for Category
+
+    def initialize(categories = [])
+      categories.each do |category|
+        add category
+      end
+    end
+
+    def prune(level)
+      level >= 0 or raise ArgumentError, "incorrect level"
+
+      items.delete_if { |k, v| v.level > level }
+    end
+
+    private
+
+    def prepare(object_or_hash)
+      category = super
+      category.parent = find(category.parent_id) if category.parent_id
+      category
+    end
+  end
+end

data/lib/goods/category.rb

@@ -0,0 +1,54 @@
+module Goods
+  class Category
+    include Containable
+    attr_accessor :parent
+    attr_field :parent_id
+    attr_field :name
+
+    def initialize(description)
+      self.description = description
+      @parent_at_level = {}
+    end
+
+    def level
+      @level ||=
+        begin
+          if parent
+            parent.level + 1
+          else
+            0
+          end
+        end
+    end
+
+    def root
+      return self unless parent
+      @root ||= parent.root
+    end
+
+    def parent_at_level(level)
+      valid_parent_level?(level) or raise ArgumentError.new('incorrect level')
+      return self if self.level == level
+
+      @parent_at_level[level] ||= parent.parent_at_level(level)
+    end
+
+    private
+
+    def valid_parent_level?(level)
+      level >= 0 && level <= self.level
+    end
+
+    def apply_validation_rules
+      validate :id, proc { |val| !(val.nil? || val.empty?) }
+      validate :name, proc { |val| !(val.nil? || val.empty?) }
+      validate :parent_id, proc { |parent_id|
+        if !(parent_id.nil? || parent_id.empty?)
+          parent && (parent.id == parent_id)
+        else
+          parent == nil
+        end
+      }
+    end
+  end
+end

data/lib/goods/containable.rb

@@ -0,0 +1,54 @@
+module Goods
+  module Containable
+    def self.included(base)
+      # Class macro that defined mathod to access instance variable @field_name
+      # in the following way (illustrative example)
+      #
+      # def field_name
+      #   @field_name ||= description[field_name]
+      # end
+      base.define_singleton_method :attr_field do |field_name|
+        define_method field_name do
+          if field = instance_variable_get("@#{field_name}")
+            field
+          else
+            instance_variable_set("@#{field_name}", description[field_name])
+            instance_variable_get("@#{field_name}")
+          end
+        end
+      end
+    end
+
+    def description
+      @description
+    end
+
+    def id
+      @id ||= description[:id]
+    end
+
+    def invalid_fields
+      @invalid_fields ||= []
+    end
+
+    def valid?
+      reset_validation
+      apply_validation_rules
+      invalid_fields.empty?
+    end
+
+    private
+
+    def reset_validation
+      invalid_fields.clear
+    end
+
+    def validate(field, predicate)
+       invalid_fields << field unless predicate.call(send(field))
+    end
+
+    def description=(description)
+      @description = description
+    end
+  end
+end

data/lib/goods/container.rb

@@ -0,0 +1,58 @@
+module Goods
+  module Container
+    def container_for(klass)
+      define_singleton_method :_containable_class do
+        klass
+      end
+
+      include ContainerMethods
+      include Enumerable
+      # Need to redefine Enumerable#find
+      include SearchMethods
+    end
+
+    module ContainerMethods
+      def add(object_or_hash)
+        element = prepare(object_or_hash)
+
+        if element.valid?
+          items[element.id] = element
+        else
+          defectives << element
+        end
+      end
+
+      def defectives
+        @defectives ||= []
+      end
+
+      def each(&block)
+        items.values.each(&block)
+      end
+
+      def size
+        items.size
+      end
+
+      private
+
+      def items
+        @items ||= {}
+      end
+
+      def prepare(object_or_hash)
+        if object_or_hash.kind_of? self.class._containable_class
+          object_or_hash
+        else
+          self.class._containable_class.new(object_or_hash)
+        end
+      end
+    end
+
+    module SearchMethods
+      def find(id)
+        items[id]
+      end
+    end
+  end
+end

data/lib/goods/currencies_list.rb

@@ -0,0 +1,12 @@
+module Goods
+  class CurrenciesList
+    extend Container
+    container_for Currency
+
+    def initialize(currencies = [])
+      currencies.each do |currency|
+        add currency
+      end
+    end
+  end
+end

data/lib/goods/currency.rb

@@ -0,0 +1,29 @@
+module Goods
+  class Currency
+    include Containable
+
+    def initialize(description)
+      self.description = description
+    end
+
+    def rate
+      @rate ||= description[:rate].to_f
+    end
+
+    def plus
+      @plus ||= description[:plus].to_f
+    end
+
+    def in(other_currency)
+      self.rate/other_currency.rate
+    end
+
+    private
+
+    def apply_validation_rules
+      validate :id, proc { |val| !(val.nil? || val.empty?) }
+      validate :rate, proc { |val| val >= 1 }
+      validate :plus, proc { |val| val >= 0 }
+    end
+  end
+end

data/lib/goods/offer.rb

@@ -0,0 +1,43 @@
+module Goods
+  class Offer
+    include Containable
+    attr_accessor :category, :currency, :price
+    attr_field :category_id
+    attr_field :currency_id
+    attr_field :available
+    attr_field :description
+    attr_field :model
+    attr_field :name
+    attr_field :picture
+    attr_field :vendor
+
+    def initialize(description)
+      self.description = description
+      @price = description[:price].to_f
+    end
+
+    def convert_currency(other_currency)
+      self.price *= currency.in(other_currency)
+      self.currency = other_currency
+      @currency_id = other_currency.id
+    end
+
+    def change_category(other_category)
+      self.category = other_category
+      @category_id = other_category.id
+    end
+
+    private
+
+    def apply_validation_rules
+      validate :id, proc { |val| !(val.nil? || val.empty?) }
+      validate :category_id, proc { |category_id|
+        category_id && category && (category_id == category.id)
+      }
+      validate :currency_id, proc { |currency_id|
+        currency_id && currency && (currency_id == currency.id)
+      }
+      validate :price, proc { |price| price && price > 0 }
+    end
+  end
+end

data/lib/goods/offers_list.rb

@@ -0,0 +1,38 @@
+module Goods
+  class OffersList
+    extend Container
+    container_for Offer
+    attr_accessor :categories_list, :currencies_list
+
+    def initialize(categories_list = nil, currencies_list = nil, offers = [])
+      self.categories_list = categories_list
+      self.currencies_list = currencies_list
+      offers.each do |offer|
+        add offer
+      end
+    end
+
+    def prune_categories(level)
+      self.each do |offer|
+        if offer.category.level > level
+          offer.change_category(offer.category.parent_at_level(level))
+        end
+      end
+    end
+
+    def convert_currency(other_currency)
+      self.each do |offer|
+        offer.convert_currency(other_currency)
+      end
+    end
+
+    private
+
+    def prepare(object_or_hash)
+      object = super
+      object.category = categories_list.find(object.category_id) if categories_list
+      object.currency = currencies_list.find(object.currency_id) if currencies_list
+      object
+    end
+  end
+end

data/lib/goods/version.rb

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

data/lib/goods/xml/validator.rb

@@ -0,0 +1,66 @@
+require "xml"
+
+module Goods
+  class XML
+    class Validator
+      attr_reader :error
+
+      def initialize
+        @error = nil
+      end
+
+      def valid?(xml)
+        validate(xml)
+        error.nil?
+      end
+
+      def validate(xml)
+        @error = nil
+        document = LibXML::XML::Document.string(xml)
+
+        # Should silence STDERR, because libxml2 spews validation error
+        # to standard error stream
+        silence_stream(STDERR) do
+          # Catch first exception due to bug in libxml - it throws
+          # 'the model is not determenistic' error. The second validation runs
+          # just fine and gives the real error.
+          begin
+            document.validate(dtd)
+          rescue LibXML::XML::Error => e
+            #nothing
+          end
+
+          begin
+            document.validate(dtd)
+          rescue LibXML::XML::Error => e
+            @error = e.to_s
+          end
+        end
+      end
+
+      private
+
+      def dtd_path
+        File.expand_path("../../../support/shops.dtd", __FILE__)
+      end
+
+      def dtd_string
+        File.read(dtd_path)
+      end
+
+      def dtd
+        @dtd ||= LibXML::XML::Dtd.new(dtd_string)
+      end
+
+      def silence_stream(stream)
+        old_stream = stream.dup
+        stream.reopen(RbConfig::CONFIG['host_os'] =~ /mswin|mingw/ ? 'NUL:' : '/dev/null')
+        stream.sync = true
+        yield
+      ensure
+        stream.reopen(old_stream)
+      end
+    end
+  end
+end
+