storexplore 0.0.1

data/lib/storexplore/testing/api_shared_examples.rb

@@ -0,0 +1,140 @@
+# -*- encoding: utf-8 -*-
+#
+# api_shared_examples.rb
+#
+# Copyright (c) 2010, 2011, 2012, 2013 by Philippe Bourgau. All rights reserved.
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 3.0 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+# MA 02110-1301  USA
+
+module Storexplore
+  module Testing
+
+    module ApiSpecMacros
+
+      def self.included(base)
+        base.send :extend, ClassMethods
+      end
+
+      module ClassMethods
+
+        def it_should_behave_like_any_store_items_api
+
+          before :all do
+            @range = 0..1
+
+            generate_store
+            explore_store
+          end
+
+          it "should have many item categories" do
+            # TODO remove .first(3) once rspec handles lazy enums
+            expect(@store.categories.first(3)).to have_at_least(3).items
+          end
+
+          it "should have many items" do
+            expect(sample_items).to have_at_least(3).items
+          end
+
+          it "should have item categories with different names" do
+            categories_attributes = sample_categories.map { |cat| cat.attributes }
+            expect(categories_attributes).to mostly have_unique(:name).in(categories_attributes)
+          end
+
+          it "should have items with different names" do
+            expect(sample_items_attributes).to mostly have_unique(:name).in(sample_items_attributes)
+          end
+
+          it "should have parseable item category attributes" do
+            expect(parseable_categories_attributes).to mostly have_key(:name)
+          end
+
+          it "should have some valid item attributes" do
+            expect(sample_items_attributes).not_to be_empty
+          end
+
+          it "should have items with a price" do
+            expect(sample_items_attributes).to all_ { have_key(:price) }
+          end
+
+          it "should mostly have items with an image" do
+            expect(sample_items_attributes).to mostly have_key(:image)
+          end
+
+          it "should mostly have items with a brand" do
+            expect(sample_items_attributes).to mostly have_key(:brand)
+          end
+
+          it "should have items with unique remote id" do
+            expect(sample_items_attributes).to all_ { have_unique(:remote_id).in(sample_items_attributes) }
+          end
+
+          it "should have items with unique uris" do
+            expect(valid_sample_items).to mostly have_unique(:uri).in(valid_sample_items)
+          end
+        end
+      end
+
+      def generate_store
+        # by default, the store already exists
+      end
+
+      def explore_store
+        @sample_categories = dig([@store], :categories)
+        @all_sample_categories, @sample_items = dig_deep(@sample_categories)
+        @valid_sample_items = valid_items(@sample_items)
+        @sample_items_attributes = (valid_sample_items.map &:attributes).uniq
+        @parseable_categories_attributes = all_sample_categories.map do |category|
+          category.attributes rescue {}
+        end
+      end
+
+      attr_accessor :sample_categories, :all_sample_categories, :sample_items, :valid_sample_items, :sample_items_attributes, :parseable_categories_attributes
+
+      def dig(categories, message)
+        categories.map { |cat| cat.send(message).to_a[@range] }.flatten
+      end
+
+      def dig_deep(categories)
+        all_categories = [categories]
+
+        while (items = dig(categories, :items)).empty?
+          categories = dig(categories, :categories)
+          all_categories << categories
+        end
+
+        [all_categories.flatten, items]
+      end
+
+      def valid_items(items)
+        result = []
+        sample_items.each do |item|
+          begin
+            item.attributes
+            result.push(item)
+          rescue BrowsingError => e
+            Testing.logger.debug e.message
+          end
+        end
+        result
+      end
+
+      def logger
+        Testing.config.logger
+      end
+
+    end
+  end
+end

data/lib/storexplore/testing/configuration.rb

@@ -0,0 +1,56 @@
+# -*- encoding: utf-8 -*-
+#
+# configuration.rb
+#
+# Copyright (c) 2010, 2011, 2012, 2013 by Philippe Bourgau. All rights reserved.
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 3.0 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+# MA 02110-1301  USA
+
+require 'logger'
+
+module Storexplore
+  module Testing
+
+    def self.config
+      @config ||= Configuration.new
+      yield @config if block_given?
+      @config
+    end
+
+    class Configuration
+
+      def initialize
+        @logger = Logger.new(STDOUT)
+        @logger.level = Logger::INFO
+      end
+
+      # Generation directory where the dummy stores will be generated.
+      # A sub folder with name DummyStore::NAME will be created there to hold all generated dummy stores,
+      # the content of this directory will be deleted when the DummyStore.wipeout method is called
+      def dummy_store_generation_dir
+        raise StandardError.new('You need to configure a dummy store generation directory with Storexplore::Testing.config.dummy_store_generation_dir=') if @generation_dir.nil?
+        @generation_dir
+      end
+      def dummy_store_generation_dir=(generation_dir)
+        @generation_dir = generation_dir
+      end
+
+      # Logger for custom test messages
+      attr_accessor :logger
+
+    end
+  end
+end

data/lib/storexplore/testing/dummy_data.rb

@@ -0,0 +1,67 @@
+# -*- coding: utf-8 -*-
+#
+# dummy_data.rb
+#
+# Copyright (c) 2012, 2013 by Philippe Bourgau. All rights reserved.
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 3.0 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+# MA 02110-1301  USA
+
+module Storexplore
+  module Testing
+
+    class DummyData
+
+      def self.name(kind)
+        "#{kind.capitalize}-#{new_int}"
+      end
+
+      def self.attributes(name, options)
+        {
+          name: name,
+          brand: brand(name),
+          image: image(name),
+          remote_id: remote_id,
+          price: price(name)
+        }.merge(options)
+      end
+
+      private
+
+      def self.brand(name)
+        "#{name} Inc."
+      end
+      def self.image(name)
+        "http://www.photofabric.com/#{name}"
+      end
+      def self.remote_id
+        new_int.to_s
+      end
+      def self.price(name)
+        hash = name.hash.abs
+        digits = Math.log(hash, 10).round
+        (hash/10.0**(digits-2)).round(2)
+      end
+
+      def self.new_int
+        @last_int ||= 0
+        result = @last_int
+        @last_int = @last_int + 1
+        result
+      end
+    end
+
+  end
+end

data/lib/storexplore/testing/dummy_store.rb

@@ -0,0 +1,195 @@
+# -*- coding: utf-8 -*-
+#
+# dummy_store.rb
+#
+# Copyright (c) 2012, 2013 by Philippe Bourgau. All rights reserved.
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 3.0 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+# MA 02110-1301  USA
+
+require "fileutils"
+
+module Storexplore
+  module Testing
+
+    class DummyStore
+
+      def self.open(store_name)
+        new(root_path(store_name), store_name)
+      end
+
+      def self.uri(store_name)
+        "file://#{root_path(store_name)}"
+      end
+
+      def self.wipe_out
+        FileUtils.rm_rf(root_dir)
+      end
+      def self.wipe_out_store(store_name)
+        FileUtils.rm_rf(root_path(store_name))
+      end
+
+      def uri
+        "file://#{@path}"
+      end
+
+      attr_reader :name
+
+      def categories
+        _name, categories, _items, _attributes = read
+        categories.map do |category_name|
+          DummyStore.new("#{absolute_category_dir(category_name)}/index.html", category_name)
+        end
+      end
+      def category(category_name)
+        short_category_name = short_name(category_name)
+        add([short_category_name], [], {})
+        DummyStore.new("#{absolute_category_dir(short_category_name)}/index.html", category_name)
+      end
+      def remove_category(category_name)
+        short_category_name = short_name(category_name)
+        remove([short_category_name], [], [])
+        FileUtils.rm_rf(absolute_category_dir(short_category_name))
+      end
+
+      def items
+        _name, _categories, items, _attributes = read
+        items.map do |item_name|
+          DummyStore.new(absolute_item_file(item_name), item_name)
+        end
+      end
+      def item(item_name)
+        short_item_name = short_name(item_name)
+        add([], [short_item_name], {})
+        DummyStore.new(absolute_item_file(short_item_name), item_name)
+      end
+      def remove_item(item_name)
+        short_item_name = short_name(item_name)
+        remove([], [short_item_name], [])
+        FileUtils.rm_rf(absolute_item_file(short_item_name))
+      end
+
+      def attributes(*args)
+        return add_attributes(args[0]) if args.size == 1
+
+        _name, _categories, _items, attributes = read
+        HashUtils.internalize_keys(attributes)
+      end
+      def add_attributes(values)
+        add([], [], HashUtils.stringify_keys(values))
+      end
+      def remove_attributes(*attribute_names)
+        remove([], [], ArrayUtils.stringify(attribute_names))
+      end
+
+      def generate(count = 1)
+        DummyStoreGenerator.new([self], count)
+      end
+
+      private
+
+      def self.root_dir
+        File.join(Testing.config.dummy_store_generation_dir, DummyStoreConstants::NAME)
+      end
+
+      def self.root_path(store_name)
+        "#{root_dir}/#{store_name}/index.html"
+      end
+
+      def initialize(path, name)
+        @path = path
+        @name = name
+        if !File.exists?(path)
+          write(name, [], [], {})
+        end
+      end
+
+      def short_name(full_name)
+        full_name[0..20]
+      end
+
+      def absolute_category_dir(category_name)
+        "#{File.dirname(@path)}/#{relative_category_dir(category_name)}"
+      end
+      def relative_category_dir(category_name)
+        category_name
+      end
+
+      def absolute_item_file(item_name)
+        "#{File.dirname(@path)}/#{relative_item_file(item_name)}"
+      end
+      def relative_item_file(item_name)
+        "#{item_name}.html"
+      end
+
+      def add(extra_categories, extra_items, extra_attributes)
+        name, categories, items, attributes = read
+
+        if !ArrayUtils.contains?(categories, extra_categories) || !ArrayUtils.contains?(items, extra_items) || !HashUtils.contains?(attributes,extra_attributes)
+          write(name, categories + extra_categories, items + extra_items, attributes.merge(extra_attributes))
+        end
+      end
+      def remove(wrong_categories, wrong_items, wrong_attributes)
+        name, categories, items, attributes = read
+        write(name, categories - wrong_categories, items - wrong_items, HashUtils.without(attributes,wrong_attributes))
+      end
+
+      def write(name, categories, items, attributes)
+        FileUtils.mkdir_p(File.dirname(@path))
+        IO.write(@path, content(name, categories, items, attributes))
+      end
+
+      def content(name, categories, items, attributes)
+        (["<!DOCTYPE html>",
+          "<html><head><meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\" /></head>",
+          "<body><h1>#{name}</h1><div id=\"categories\"><h2>Categories</h2><ul>"] +
+         categories.map {|cat|  "<li><a class=\"category\" href=\"#{relative_category_dir(cat)}/index.html\">#{cat}</a></li>" } +
+         ['</ul></div><div id="items"><h2>Items</h2><ul>']+
+         items.map      {|item| "<li><a class=\"item\" href=\"#{relative_item_file(item)}\">#{item}</a></li>" } +
+         ['</ul></div><div id="attributes"><h2>Attributes</h2><ul>']+
+         attributes.map {|key, value| "<li><span id=\"#{key}\">#{value}</span></li>" } +
+         ["</ul></div></body></html>"]).join("\n")
+      end
+
+      def read
+        parse(IO.readlines(@path))
+      end
+
+      def parse(lines)
+        name = ""
+        categories = []
+        items = []
+        attributes = {}
+        lines.each do |line|
+          name_match = /<h1>([^<]+)<\/h1>/.match(line)
+          sub_match = /<li><a class=\"([^\"]+)\" href=\"[^\"]+.html\">([^<]+)<\/a><\/li>/.match(line)
+          attr_match = /<li><span id=\"([^\"]+)\">([^<]+)<\/span><\/li>/.match(line)
+
+          if !!name_match
+            name = name_match[1]
+          elsif !!sub_match
+            case sub_match[1]
+            when "category" then categories << sub_match[2]
+            when "item" then items << sub_match[2]
+            end
+          elsif !!attr_match
+            attributes[attr_match[1]] = attr_match[2]
+          end
+        end
+        [name, categories, items, attributes]
+      end
+    end
+  end
+end

data/lib/storexplore/testing/dummy_store_api.rb

@@ -0,0 +1,54 @@
+# -*- coding: utf-8 -*-
+#
+# dummy_store_api.rb
+#
+# Copyright (c) 2012, 2013 by Philippe Bourgau. All rights reserved.
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 3.0 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+# MA 02110-1301  USA
+
+require_relative 'dummy_store_constants'
+
+module Storexplore
+  module Testing
+
+    Storexplore::define_api DummyStoreConstants::NAME do
+
+      categories 'a.category' do
+        attributes do
+          { :name => page.get_one("h1").content }
+        end
+
+        categories 'a.category' do
+          attributes do
+            { :name => page.get_one("h1").content }
+          end
+
+          items 'a.item' do
+            attributes do
+              {
+                :name => page.get_one('h1').content,
+                :brand => page.get_one('#brand').content,
+                :price => page.get_one('#price').content.to_f,
+                :image => page.get_one('#image').content,
+                :remote_id => page.get_one('#remote_id').content
+              }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/storexplore/testing/dummy_store_constants.rb

@@ -0,0 +1,31 @@
+# -*- coding: utf-8 -*-
+#
+# dummy_store_constants.rb
+#
+# Copyright (c) 2013 by Philippe Bourgau. All rights reserved.
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 3.0 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+# MA 02110-1301  USA
+
+module Storexplore
+  module Testing
+
+    class DummyStoreConstants
+
+      NAME = 'dummy-store'
+
+    end
+  end
+end

data/lib/storexplore/testing/dummy_store_generator.rb

@@ -0,0 +1,65 @@
+# -*- coding: utf-8 -*-
+#
+# dummy_store_generator.rb
+#
+# Copyright (c) 2012, 2013 by Philippe Bourgau. All rights reserved.
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 3.0 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+# MA 02110-1301  USA
+
+module Storexplore
+  module Testing
+
+    class DummyStoreGenerator
+      def initialize(pages, count = 1)
+        @pages = pages
+        @count = count
+      end
+
+      def and(count)
+        @count = count
+        self
+      end
+
+      def categories
+        dispatch(:category)
+      end
+      alias_method :category, :categories
+
+      def items
+        dispatch(:item).attributes
+      end
+      alias_method :item, :items
+
+      def attributes(options = {})
+        @pages.map do |page|
+          attributes = DummyData.attributes(page.name, options)
+          page.attributes(HashUtils.without(attributes, [:name]))
+        end
+      end
+
+      private
+
+      def dispatch(message)
+        sub_pages = @pages.map do |page|
+          @count.times.map do
+            page.send(message, DummyData.name(message))
+          end
+        end
+        DummyStoreGenerator.new(sub_pages.flatten)
+      end
+    end
+  end
+end

data/lib/storexplore/testing/matchers/have_unique_matcher.rb

@@ -0,0 +1,74 @@
+# -*- encoding: utf-8 -*-
+#
+# have_unique_matcher.rb
+#
+# Copyright (c) 2010, 2011, 2013 by Philippe Bourgau. All rights reserved.
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 3.0 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+# MA 02110-1301  USA
+
+
+# Matcher to verify that a hash's key is unique in a collection of other hashes
+# a full class is required to implement the in method
+# Use like: expect(hash).to have_unique(:id).in(hashes)
+class HaveUnique
+
+  def initialize(key)
+    @key = key
+  end
+
+  def in(collection)
+    @collection = collection
+    @index = Hash.new(0)
+    collection.each do |item|
+      @index[value(item)] += 1
+    end
+    self
+  end
+
+  def matches?(actual)
+    @actual = actual
+    @index[value(actual)] == 1
+  end
+
+  def failure_message_for_should
+    "expected #{value_expression(actual)} (=#{value(actual)}) to be unique in #{@collection}"
+  end
+
+  def description
+    "expected an hash or object with a unique #{@key} in #{@collection}"
+  end
+
+  private
+  def value(actual)
+    if actual.instance_of?(Hash)
+      actual[@key]
+    else
+      actual.send(@key)
+    end
+  end
+  def value_expression(actual)
+    if actual.instance_of?(Hash)
+      "#{actual}[#{@key}]"
+    else
+      "#{actual}.#{@key}"
+    end
+  end
+end
+
+def have_unique(key)
+  HaveUnique.new(key)
+end
+