storexplore 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7ffcb1b7ac49f590bdeafde98b7c6e3f6a4aecb8
-  data.tar.gz: fbb03b9a51c7eab05ffea0d1498cf5b8f15413ec
+  metadata.gz: f9aad6223151eb82e5a00d692857bae568271a7f
+  data.tar.gz: 02565e1894429c9afbafe786817a7991c41248f4
 SHA512:
-  metadata.gz: 94933a0836b830b49ac03fe4f604bf9f8be35cf6e1518a1ceb92b42ae03f76deb7d10e7e9a38cbff4753ea1a8eb3c4607d82445e28397ff3e45f1053bb2306ce
-  data.tar.gz: 94c3a3291e638198fba5b19071449eeaa40cfbaac57db6cb28cb4f7294c515d4a895524448e618aad404dd412bff240eb386e99a329046dda79ba2a0e2e2766e
+  metadata.gz: 232031993870546c1bd5abcf442f5710eac133dd75bcd3342aacd41e7d87ec7c68bff2b7b8c911ecb8b3fadc20f3c6a1763b2474a2b9c065204ac756aacddbb1
+  data.tar.gz: 52d3a90be6cc7bc8c4805752c7fab05083efc6d8f9f0c5d3e255d19abaecd470538850edc8c2b234b6ae01d329e33eef37688eff384640474d16acca1dae9e28

data/lib/storexplore/testing.rb

@@ -20,6 +20,7 @@
 # MA 02110-1301  USA
 
 require 'storexplore'
+require 'storexplore/testing/api_shared_context'
 require 'storexplore/testing/api_shared_examples'
 require 'storexplore/testing/configuration'
 require 'storexplore/testing/dummy_data'

data/lib/storexplore/testing/api_shared_context.rb

@@ -0,0 +1,83 @@
+# -*- encoding: utf-8 -*-
+#
+# api_shared_context.rb
+#
+# Copyright (c) 2010-2014 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
+
+    shared_context "a scrapped store" do
+
+      before :all do
+        @range = 0..1
+
+        expect(self).to(respond_to(:generate_store), "You should implement generate_store to include the scrapped store shared context")
+
+        self.store = generate_store
+        explore_store
+      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 :store, :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/api_shared_examples.rb

@@ -22,119 +22,54 @@
 module Storexplore
   module Testing
 
-    module ApiSpecMacros
+    shared_examples "an API" do
 
-      def self.included(base)
-        base.send :extend, ClassMethods
+      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
 
-      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
+      it "should have many items" do
+        expect(sample_items).to have_at_least(3).items
       end
 
-      def generate_store
-        # by default, the store already exists
+      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
 
-      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
+      it "should have items with different names" do
+        expect(sample_items_attributes).to mostly have_unique(:name).in(sample_items_attributes)
       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
+      it "should have parseable item category attributes" do
+        expect(parseable_categories_attributes).to mostly have_key(:name)
       end
 
-      def dig_deep(categories)
-        all_categories = [categories]
+      it "should have some valid item attributes" do
+        expect(sample_items_attributes).not_to be_empty
+      end
 
-        while (items = dig(categories, :items)).empty?
-          categories = dig(categories, :categories)
-          all_categories << categories
-        end
+      it "should have items with a price" do
+        expect(sample_items_attributes).to all_ { have_key(:price) }
+      end
 
-        [all_categories.flatten, items]
+      it "should mostly have items with an image" do
+        expect(sample_items_attributes).to mostly have_key(:image)
       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
+      it "should mostly have items with a brand" do
+        expect(sample_items_attributes).to mostly have_key(:brand)
       end
 
-      def logger
-        Testing.config.logger
+      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
 end

data/lib/storexplore/version.rb

@@ -20,5 +20,5 @@
 # MA 02110-1301  USA
 
 module Storexplore
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/spec/lib/storexplore/testing/dummy_store_api_shared_context.rb

@@ -0,0 +1,47 @@
+# -*- encoding: utf-8 -*-
+#
+# dummy_store_api_shared_context.rb
+#
+# Copyright (c) 2011-2014 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 'spec_helper'
+
+module Storexplore
+  module Testing
+
+    shared_context "a generated dummy store" do
+      def default_store_name
+        "www.spec-store.com"
+      end
+
+      def generate_store(store_name = default_store_name, item_count = 3)
+        DummyStore.wipe_out_store(store_name)
+        @store_generator = DummyStore.open(store_name)
+        @store_generator.generate(3).categories.and(3).categories.and(item_count).items
+
+        new_store(store_name)
+      end
+
+      def new_store(store_name = default_store_name)
+        Api.browse(DummyStore.uri(store_name))
+      end
+
+    end
+
+  end
+end

data/spec/lib/storexplore/testing/dummy_store_api_spec.rb

@@ -20,27 +20,15 @@
 # MA 02110-1301  USA
 
 require 'spec_helper'
+require_relative 'dummy_store_api_shared_context'
 
 module Storexplore
   module Testing
 
     describe "DummyStoreApi", slow: true do
-      include ApiSpecMacros
-
-      it_should_behave_like_any_store_items_api
-
-      DEFAULT_STORE_NAME = "www.spec-store.com"
-
-      def generate_store(store_name = DEFAULT_STORE_NAME, item_count = 3)
-        DummyStore.wipe_out_store(store_name)
-        @store_generator = DummyStore.open(store_name)
-        @store_generator.generate(3).categories.and(3).categories.and(item_count).items
-        @store = new_store(store_name)
-      end
-
-      def new_store(store_name = DEFAULT_STORE_NAME)
-        Api.browse(DummyStore.uri(store_name))
-      end
+      include_context "a generated dummy store"
+      include_context "a scrapped store"
+      it_should_behave_like "an API"
 
       it "should not truncate long item names" do
         @store_generator.
@@ -58,84 +46,6 @@ module Storexplore
         expect(item.attributes[:name]).to eq item_name
       end
 
-      it "should use constant memory" do
-        FEW = 10
-        MANY = 100
-        RUNS = 2
-
-        many_inputs_memory = memory_usage_for_items(MANY, RUNS)
-        few_inputs_memory = memory_usage_for_items(FEW, RUNS)
-
-        slope = (many_inputs_memory - few_inputs_memory) / (MANY - FEW)
-
-        zero_inputs_memory = few_inputs_memory - FEW * slope
-
-        expect(slope).to be_within(zero_inputs_memory * 0.05).of(0.0)
-      end
-
-      def memory_usage_for_items(item_count, runs)
-        generate_store(store_name = "www.spec-perf-store.com", item_count)
-        data = runs.times.map do
-          memory_peak_of do
-            walk_store(store_name)
-          end
-        end
-        mean(data)
-      end
-
-      def memory_peak_of
-        peak_usage = 0
-        finished = false
-
-        initial_usage = current_living_objects
-        profiler = Thread.new do
-          while not finished
-            peak_usage = [peak_usage, current_living_objects].max
-            sleep(0.01)
-          end
-        end
-
-        yield
-
-        finished = true
-        profiler.join
-
-        peak_usage - initial_usage
-      end
-
-      def current_living_objects
-        object_counts = ObjectSpace.count_objects
-        object_counts[:TOTAL] - object_counts[:FREE]
-      end
-
-      def walk_store(store_name)
-        new_store(store_name).categories.each do |category|
-          register(category)
-
-          category.categories.each do |sub_category|
-            register(sub_category)
-
-            sub_category.items.each do |item|
-              register(item)
-            end
-          end
-        end
-      end
-
-      def register(store_node)
-        @title = store_node.title
-        @attributes = store_node.attributes
-
-        # No GC is explicitly done, because:
-        #  - large inputs forces it anyway
-        #  - it greatly slows tests
-        #  - GCing should not change the complexity of the system
-        # GC.start
-      end
-
-      def mean(data)
-        data.reduce(:+)/data.size
-      end
     end
 
   end

data/spec/lib/storexplore/testing/memory_usage_spec.rb

@@ -0,0 +1,127 @@
+# -*- encoding: utf-8 -*-
+#
+# memory_usage_spec.rb
+#
+# Copyright (c) 2011-2014 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 'spec_helper'
+require_relative 'dummy_store_api_shared_context'
+
+module Storexplore
+  module Testing
+
+    describe "DummyStoreApi", slow: true do
+      include_context "a generated dummy store"
+      include_context "a scrapped store"
+
+      DEFAULT_STORE_NAME = "www.spec-store.com"
+
+      def generate_store(store_name = DEFAULT_STORE_NAME, item_count = 3)
+        DummyStore.wipe_out_store(store_name)
+        @store_generator = DummyStore.open(store_name)
+        @store_generator.generate(3).categories.and(3).categories.and(item_count).items
+
+        new_store(store_name)
+      end
+
+      def new_store(store_name = DEFAULT_STORE_NAME)
+        Api.browse(DummyStore.uri(store_name))
+      end
+
+      it "should use constant memory" do
+        FEW = 10
+        MANY = 100
+        RUNS = 2
+
+        many_inputs_memory = memory_usage_for_items(MANY, RUNS)
+        few_inputs_memory = memory_usage_for_items(FEW, RUNS)
+
+        slope = (many_inputs_memory - few_inputs_memory) / (MANY - FEW)
+
+        zero_inputs_memory = few_inputs_memory - FEW * slope
+
+        expect(slope).to be_within(zero_inputs_memory * 0.05).of(0.0)
+      end
+
+      def memory_usage_for_items(item_count, runs)
+        generate_store(store_name = "www.spec-perf-store.com", item_count)
+        data = runs.times.map do
+          memory_peak_of do
+            walk_store(store_name)
+          end
+        end
+        mean(data)
+      end
+
+      def memory_peak_of
+        peak_usage = 0
+        finished = false
+
+        initial_usage = current_living_objects
+        profiler = Thread.new do
+          while not finished
+            peak_usage = [peak_usage, current_living_objects].max
+            sleep(0.01)
+          end
+        end
+
+        yield
+
+        finished = true
+        profiler.join
+
+        peak_usage - initial_usage
+      end
+
+      def current_living_objects
+        object_counts = ObjectSpace.count_objects
+        object_counts[:TOTAL] - object_counts[:FREE]
+      end
+
+      def walk_store(store_name)
+        new_store(store_name).categories.each do |category|
+          register(category)
+
+          category.categories.each do |sub_category|
+            register(sub_category)
+
+            sub_category.items.each do |item|
+              register(item)
+            end
+          end
+        end
+      end
+
+      def register(store_node)
+        @title = store_node.title
+        @attributes = store_node.attributes
+
+        # No GC is not explicitly done, because:
+        #  - large inputs forces it anyway
+        #  - it greatly slows tests
+        #  - GCing should not change the complexity of the system
+        # GC.start
+      end
+
+      def mean(data)
+        data.reduce(:+)/data.size
+      end
+    end
+
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: storexplore
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Philou
@@ -31,7 +31,7 @@ cert_chain:
   yLcl1cmm5ALtJ/+Bkkmp0i4amXeTDMvq9r8PBsVsQwxYOYJBP+Umxz3PX6HjFHrQ
   XdkXx3oZ
   -----END CERTIFICATE-----
-date: 2014-01-16 00:00:00.000000000 Z
+date: 2014-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mechanize
@@ -142,6 +142,7 @@ files:
 - lib/storexplore/hash_utils.rb
 - lib/storexplore/null_digger.rb
 - lib/storexplore/testing.rb
+- lib/storexplore/testing/api_shared_context.rb
 - lib/storexplore/testing/api_shared_examples.rb
 - lib/storexplore/testing/configuration.rb
 - lib/storexplore/testing/dummy_data.rb
@@ -159,7 +160,9 @@ files:
 - spec/lib/storexplore/api_spec.rb
 - spec/lib/storexplore/dsl_spec.rb
 - spec/lib/storexplore/store_walker_page_spec_fixture.html
+- spec/lib/storexplore/testing/dummy_store_api_shared_context.rb
 - spec/lib/storexplore/testing/dummy_store_api_spec.rb
+- spec/lib/storexplore/testing/memory_usage_spec.rb
 - spec/lib/storexplore/uri_utils_spec.rb
 - spec/lib/storexplore/walker_page_spec.rb
 - spec/spec_helper.rb
@@ -192,7 +195,9 @@ test_files:
 - spec/lib/storexplore/api_spec.rb
 - spec/lib/storexplore/dsl_spec.rb
 - spec/lib/storexplore/store_walker_page_spec_fixture.html
+- spec/lib/storexplore/testing/dummy_store_api_shared_context.rb
 - spec/lib/storexplore/testing/dummy_store_api_spec.rb
+- spec/lib/storexplore/testing/memory_usage_spec.rb
 - spec/lib/storexplore/uri_utils_spec.rb
 - spec/lib/storexplore/walker_page_spec.rb
 - spec/spec_helper.rb