paginae 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51b81660d03e3fb92a5cb8ab12995813ee979be57ce6b3a2971acab57e590418
-  data.tar.gz: ef8989a64d197557315a0f7390bd14b8279ead060f6187f7b6fdb7b99f0f2fe1
+  metadata.gz: 6fce7acf7bb8f43e9ca22ce7084e0b720811acff7fe28001261256357d93829a
+  data.tar.gz: ceaa9ed9c9c76ce777325b7de623157b1bbef37ee4c2d5aec0951bb2aa565085
 SHA512:
-  metadata.gz: d42ea335bf766e4eaf371036b515e92792f86fa3c80a23355cff2c63b8e280efaa5a3b76f7d0e7cfabd11f2e914f843a1a5e2e8156af37ca83a15f7257fa944a
-  data.tar.gz: 1338900ec4e6ebbd83917824610bfdb7c65d9cac3150dcc530e931e03e324f005a1a197fb2f5118895fbbf84ceb15d256b1ba64a3aba2edd134fd0b680067a20
+  metadata.gz: 5158c1120fb6f0e3ce8021cee76297ddb5745c0d55a1706507602f39635f4a865d1bde0219199cfe8e97d36a05a444309ffbf686945eb2df8df650488764939b
+  data.tar.gz: 5f806d1ad1be0b8d5f8391a80f7b29ebe3901e494c1d005ca6c0da9c2de33f4982e5d135460570ebc9190e0bdb2eb5bdea5837cedadb5ccc7a506a2beea075f5

data/.rubocop.yml

@@ -1,9 +1,11 @@
-inherit_from: .rubocop_todo.yml
-
 AllCops:
   TargetRubyVersion: 2.7
+  SuggestExtensions: false
   NewCops: enable
 
+Style/Documentation:
+  Enabled: false
+
 Style/StringLiterals:
   Enabled: true
   EnforcedStyle: double_quotes
@@ -13,7 +15,11 @@ Style/StringLiteralsInInterpolation:
   EnforcedStyle: double_quotes
 
 Layout/LineLength:
-  Max: 130
+  Exclude:
+    - test/**/*.rb
 
-Style/Documentation:
-  Enabled: false
+Metrics/MethodLength:
+  Max: 16
+
+Metrics/CyclomaticComplexity:
+  Max: 9

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    paginae (0.1.2)
+    paginae (0.1.4)
       nokogiri (>= 1.13.4)
 
 GEM
@@ -27,17 +27,17 @@ GEM
     racc (1.6.0)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.4.0)
+    regexp_parser (2.5.0)
     reline (0.3.1)
       io-console (~> 0.5)
     rexml (3.2.5)
-    rubocop (1.29.1)
+    rubocop (1.30.0)
       parallel (~> 1.10)
       parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.17.0, < 2.0)
+      rubocop-ast (>= 1.18.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
     rubocop-ast (1.18.0)

data/README.md

@@ -30,6 +30,7 @@ class ProductPage
   attribute :name, id: "product-title"
   attribute :model, xpath: "//h2[@class='product-model']"
   attribute :summary, css: "#product-overview"
+  attribute :image_url, css: "#product-image", value: :src
   attribute :colors, css: ".product-colors li" listed: true
   attribute :sizes, css: ".product-sizes" listed: -> { |e| e.text.split(', ') }
   attribute :prices, css: ".product-price", mapped: ->(price) { ["USD", price.text.gsub(/[^\d\.]/, '').to_f] }

data/lib/paginae/attribute_injector.rb

@@ -3,113 +3,23 @@
 module Paginae
   module AttributeInjector
     def self.extended(base)
-      base.class_eval do
-        def data
-          instance_variables
-            .reject { |var| var.to_s =~ /_node/ }
-            .to_h { |var| [var.to_s.sub("@", "").to_sym, instance_variable_get(var)] }
-            .compact
-        end
-      end
-
       class << base
+        include NodeBuilder
+        include ReaderBuilder
+
         def attribute(name, **kwargs)
           __define_node(name, **kwargs)
           __define_reader(name, **kwargs)
+          instance_variable_set("@paginae_attributes", Set.new) unless instance_variable_defined?("@paginae_attributes")
+          instance_variable_get("@paginae_attributes").add(name.to_sym)
         end
 
-        private
-
-        def __define_node(name, **kwargs)
-          selector = __node_selector(**kwargs)
-          define_method("__#{name}_nodes") do
-            instance_variable_get("@#{name}_nodes") || instance_variable_set("@#{name}_node", document.send(*selector))
-          end
-          private "__#{name}_nodes"
-
-          define_method("__#{name}_node") do
-            send("__#{name}_nodes").first
-          end
-          private "__#{name}_node"
-        end
-
-        def __node_selector(**kwargs)
-          if kwargs.key?(:css)
-            kwargs.slice(:css).to_a.flatten
-          elsif kwargs.key?(:xpath)
-            kwargs.slice(:xpath).to_a.flatten
-          elsif kwargs.key?(:id)
-            [:xpath, "//*[@id='#{kwargs[:id]}']"]
-          else
-            raise ArgumentError, "Undefined selector type"
-          end
-        end
-
-        def __define_reader(name, **kwargs)
-          if kwargs.key?(:mapped)
-            __define_map_reader(name, **kwargs)
-          elsif kwargs.key?(:listed)
-            __define_list_reader(name, **kwargs)
-          elsif kwargs.key?(:value)
-            __define_value_reader(name, **kwargs)
-          else
-            __define_text_reader(name)
-          end
-        end
-
-        def __define_map_reader(name, **kwargs)
-          define_method name do
-            return instance_variable_get("@#{name}") if instance_variable_defined?("@#{name}")
-
-            map = send("__#{name}_nodes")&.to_h do |node|
-              case kwargs[:mapped]
-              when Symbol
-                send(kwargs[:mapped], node)
-              when Proc
-                kwargs[:mapped].call(node)
-              else
-                raise ArgumentError, "Invalid mapped type"
-              end
-            end
-            instance_variable_set("@#{name}", map&.compact)
-          end
-        end
-
-        def __define_list_reader(name, **kwargs)
-          define_method name do
-            return instance_variable_get("@#{name}") if instance_variable_defined?("@#{name}")
-
-            list = send("__#{name}_nodes")&.map do |node|
-              case kwargs[:listed]
-              when TrueClass
-                node&.text&.strip
-              when Symbol
-                send(kwargs[:listed], node)
-              when Proc
-                kwargs[:listed].call(node)
-              else
-                raise ArgumentError, "Invalid listed type"
-              end
-            end
-            instance_variable_set("@#{name}", list&.compact)
-          end
-        end
-
-        def __define_text_reader(name)
-          define_method name do
-            return instance_variable_get("@#{name}") if instance_variable_defined?("@#{name}")
-
-            instance_variable_set("@#{name}", send("__#{name}_node")&.text&.gsub(/\s+/, " ")&.strip)
-          end
-        end
-
-        def __define_value_reader(name, **kwargs)
-          define_method name do
-            return instance_variable_get("@#{name}") if instance_variable_defined?("@#{name}")
+        attr_reader :paginae_attributes
+      end
 
-            instance_variable_set("@#{name}",
-                                  send("__#{name}_node")&.attribute(kwargs[:value].to_s)&.value&.gsub(/\s+/, " ")&.strip)
-          end
+      base.class_eval do
+        def data
+          self.class.paginae_attributes.to_h { |key| [key, send(key)] }
         end
       end
     end

data/lib/paginae/memoizer.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Paginae
+  module Memoizer
+    def define_memoized_method(name)
+      define_method name do
+        return instance_variable_get("@#{name}") if instance_variable_defined?("@#{name}")
+
+        instance_variable_set("@#{name}", yield(self))
+      end
+    end
+  end
+end

data/lib/paginae/node_builder.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Paginae
+  module NodeBuilder
+    include Memoizer
+
+    private
+
+    def __define_node(name, **kwargs)
+      define_memoized_method("__#{name}_nodes") do |instance|
+        instance.document.send(*__node_selector(**kwargs))
+      end
+      private "__#{name}_nodes"
+
+      define_method("__#{name}_node") do
+        send("__#{name}_nodes").first
+      end
+      private "__#{name}_node"
+    end
+
+    def __node_selector(css: nil, xpath: nil, id: nil, **kwargs)
+      if css
+        [:css, css]
+      elsif xpath
+        [:xpath, xpath]
+      elsif id
+        [:xpath, "//*[@id='#{id}']"]
+      else
+        raise ArgumentError, "Undefined selector type for #{kwargs}"
+      end
+    end
+  end
+end

data/lib/paginae/reader_builder/array.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Paginae
+  module ReaderBuilder
+    module Array
+      using SpaceStriper
+
+      private
+
+      def __define_list_reader(name, method)
+        define_memoized_method name do |instance|
+          instance.send("__#{name}_nodes")&.map do |node|
+            case method
+            when TrueClass
+              node&.text&.space_strip
+            when Symbol
+              instance.send(method, node)
+            when Proc
+              method.call(node)
+            else
+              raise ArgumentError, "Invalid listed type for #{method.class}"
+            end
+          end&.compact
+        end
+      end
+    end
+  end
+end

data/lib/paginae/reader_builder/hash.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Paginae
+  module ReaderBuilder
+    module Hash
+      private
+
+      def __define_hash_reader(name, method)
+        define_memoized_method name do |instance|
+          instance.send("__#{name}_nodes")&.to_h do |node|
+            case method
+            when Symbol
+              instance.send(method, node)
+            when Proc
+              method.call(node)
+            else
+              raise ArgumentError, "Invalid mapped type for #{method.class}"
+            end
+          end&.compact
+        end
+      end
+    end
+  end
+end

data/lib/paginae/reader_builder/text.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Paginae
+  module ReaderBuilder
+    module Text
+      using SpaceStriper
+
+      private
+
+      def __define_text_reader(name)
+        define_memoized_method name do |instance|
+          instance
+            .send("__#{name}_node")
+            &.text
+            &.space_strip
+        end
+      end
+    end
+  end
+end

data/lib/paginae/reader_builder/value.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Paginae
+  module ReaderBuilder
+    module Value
+      using SpaceStriper
+
+      private
+
+      def __define_value_reader(name, value)
+        define_memoized_method name do |instance|
+          instance
+            .send("__#{name}_node")
+            &.attribute(value.to_s)
+            &.value
+            &.space_strip
+        end
+      end
+    end
+  end
+end

data/lib/paginae/reader_builder.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "reader_builder/array"
+require_relative "reader_builder/hash"
+require_relative "reader_builder/text"
+require_relative "reader_builder/value"
+
+module Paginae
+  module ReaderBuilder
+    include Memoizer
+    include Array
+    include Hash
+    include Text
+    include Value
+
+    private
+
+    def __define_reader(name, mapped: nil, listed: nil, value: nil, **_kwargs)
+      if mapped
+        __define_hash_reader(name, mapped)
+      elsif listed
+        __define_list_reader(name, listed)
+      elsif value
+        __define_value_reader(name, value)
+      else
+        __define_text_reader(name)
+      end
+    end
+  end
+end

data/lib/paginae/space_striper.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Paginae
+  module SpaceStriper
+    refine NilClass do
+      def space_strip
+        self
+      end
+    end
+
+    refine String do
+      def space_strip
+        gsub(/\s+/, " ").strip
+      end
+    end
+  end
+end

data/lib/paginae/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Paginae
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

data/lib/paginae.rb

@@ -2,8 +2,12 @@
 
 require "nokogiri"
 require_relative "paginae/version"
+require_relative "paginae/space_striper"
+require_relative "paginae/memoizer"
 require_relative "paginae/html_initializer_injector"
 require_relative "paginae/attribute_injector"
+require_relative "paginae/node_builder"
+require_relative "paginae/reader_builder"
 require_relative "paginae/web"
 
 module Paginae

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paginae
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Luis Ezcurdia
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-26 00:00:00.000000000 Z
+date: 2022-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -32,7 +32,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".rubocop.yml"
-- ".rubocop_todo.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -43,6 +42,14 @@ files:
 - lib/paginae.rb
 - lib/paginae/attribute_injector.rb
 - lib/paginae/html_initializer_injector.rb
+- lib/paginae/memoizer.rb
+- lib/paginae/node_builder.rb
+- lib/paginae/reader_builder.rb
+- lib/paginae/reader_builder/array.rb
+- lib/paginae/reader_builder/hash.rb
+- lib/paginae/reader_builder/text.rb
+- lib/paginae/reader_builder/value.rb
+- lib/paginae/space_striper.rb
 - lib/paginae/version.rb
 - lib/paginae/web.rb
 - sig/paginae.rbs

data/.rubocop_todo.yml

@@ -1,27 +0,0 @@
-# This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2022-04-29 18:20:44 UTC using RuboCop version 1.28.2.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.
-
-# Offense count: 1
-# Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
-Metrics/AbcSize:
-  Exclude:
-    - lib/paginae/attribute_injector.rb
-
-# Offense count: 1
-# Configuration parameters: IgnoredMethods.
-Metrics/CyclomaticComplexity:
-  Max: 27
-
-# Offense count: 1
-# Configuration parameters: IgnoredMethods.
-Metrics/PerceivedComplexity:
-  Max: 27
-
-Metrics/MethodLength:
-  Exclude:
-    - lib/paginae/attribute_injector.rb