RubyGems - dh_easy-core - Versions diffs - 0.2.2 - Mend

dh_easy-core 0.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (79) hide show

checksums.yaml +7 -0
data/.gitignore +12 -0
data/.travis.yml +7 -0
data/.yardopts +1 -0
data/CODE_OF_CONDUCT.md +74 -0
data/Gemfile +6 -0
data/LICENSE +21 -0
data/README.md +20 -0
data/Rakefile +22 -0
data/dh_easy-core.gemspec +50 -0
data/doc/DhEasy.html +117 -0
data/doc/DhEasy/Core.html +1590 -0
data/doc/DhEasy/Core/Config.html +311 -0
data/doc/DhEasy/Core/Exception.html +117 -0
data/doc/DhEasy/Core/Exception/OutdatedError.html +135 -0
data/doc/DhEasy/Core/Helper.html +117 -0
data/doc/DhEasy/Core/Helper/Cookie.html +1070 -0
data/doc/DhEasy/Core/Mock.html +282 -0
data/doc/DhEasy/Core/Mock/FakeDb.html +3779 -0
data/doc/DhEasy/Core/Mock/FakeExecutor.html +3289 -0
data/doc/DhEasy/Core/Mock/FakeFinisher.html +160 -0
data/doc/DhEasy/Core/Mock/FakeParser.html +160 -0
data/doc/DhEasy/Core/Mock/FakeSeeder.html +160 -0
data/doc/DhEasy/Core/Plugin.html +117 -0
data/doc/DhEasy/Core/Plugin/CollectionVault.html +299 -0
data/doc/DhEasy/Core/Plugin/ConfigBehavior.html +541 -0
data/doc/DhEasy/Core/Plugin/ContextIntegrator.html +445 -0
data/doc/DhEasy/Core/Plugin/Executor.html +259 -0
data/doc/DhEasy/Core/Plugin/ExecutorBehavior.html +344 -0
data/doc/DhEasy/Core/Plugin/Finisher.html +265 -0
data/doc/DhEasy/Core/Plugin/FinisherBehavior.html +142 -0
data/doc/DhEasy/Core/Plugin/InitializeHook.html +220 -0
data/doc/DhEasy/Core/Plugin/Parser.html +270 -0
data/doc/DhEasy/Core/Plugin/ParserBehavior.html +235 -0
data/doc/DhEasy/Core/Plugin/Seeder.html +674 -0
data/doc/DhEasy/Core/Plugin/SeederBehavior.html +142 -0
data/doc/DhEasy/Core/SmartCollection.html +1087 -0
data/doc/_index.html +364 -0
data/doc/class_list.html +51 -0
data/doc/css/common.css +1 -0
data/doc/css/full_list.css +58 -0
data/doc/css/style.css +496 -0
data/doc/file.README.html +91 -0
data/doc/file_list.html +56 -0
data/doc/frames.html +17 -0
data/doc/index.html +91 -0
data/doc/js/app.js +303 -0
data/doc/js/full_list.js +216 -0
data/doc/js/jquery.js +4 -0
data/doc/method_list.html +939 -0
data/doc/top-level-namespace.html +110 -0
data/lib/dh_easy/core.rb +257 -0
data/lib/dh_easy/core/config.rb +27 -0
data/lib/dh_easy/core/exception.rb +8 -0
data/lib/dh_easy/core/exception/outdated_error.rb +9 -0
data/lib/dh_easy/core/helper.rb +8 -0
data/lib/dh_easy/core/helper/cookie.rb +209 -0
data/lib/dh_easy/core/mock.rb +45 -0
data/lib/dh_easy/core/mock/fake_db.rb +561 -0
data/lib/dh_easy/core/mock/fake_executor.rb +373 -0
data/lib/dh_easy/core/mock/fake_finisher.rb +28 -0
data/lib/dh_easy/core/mock/fake_parser.rb +33 -0
data/lib/dh_easy/core/mock/fake_seeder.rb +28 -0
data/lib/dh_easy/core/plugin.rb +19 -0
data/lib/dh_easy/core/plugin/collection_vault.rb +23 -0
data/lib/dh_easy/core/plugin/config_behavior.rb +43 -0
data/lib/dh_easy/core/plugin/context_integrator.rb +60 -0
data/lib/dh_easy/core/plugin/executor.rb +19 -0
data/lib/dh_easy/core/plugin/executor_behavior.rb +32 -0
data/lib/dh_easy/core/plugin/finisher.rb +19 -0
data/lib/dh_easy/core/plugin/finisher_behavior.rb +9 -0
data/lib/dh_easy/core/plugin/initialize_hook.rb +17 -0
data/lib/dh_easy/core/plugin/parser.rb +19 -0
data/lib/dh_easy/core/plugin/parser_behavior.rb +17 -0
data/lib/dh_easy/core/plugin/seeder.rb +44 -0
data/lib/dh_easy/core/plugin/seeder_behavior.rb +9 -0
data/lib/dh_easy/core/smart_collection.rb +236 -0
data/lib/dh_easy/core/version.rb +6 -0
metadata +249 -0

data/doc/top-level-namespace.html ADDED Viewed

@@ -0,0 +1,110 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Top Level Namespace
+    &mdash; Documentation by YARD 0.9.20
+</title>
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  pathId = "";
+  relpath = '';
+</script>
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+    <a href="_index.html">Index</a> &raquo;
+    <span class="title">Top Level Namespace</span>
+</div>
+        <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+</div>
+        <div class="clear"></div>
+      </div>
+      <div id="content"><h1>Top Level Namespace
+</h1>
+<div class="box_info">
+</div>
+<h2>Defined Under Namespace</h2>
+<p class="children">
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="DhEasy.html" title="DhEasy (module)">DhEasy</a></span>
+</p>
+</div>
+      <div id="footer">
+  Generated on Wed Dec  4 23:00:02 2019 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.20 (ruby-2.5.3).
+</div>
+    </div>
+  </body>
+</html>

data/lib/dh_easy/core.rb ADDED Viewed

@@ -0,0 +1,257 @@
+require 'time'
+require 'faker'
+require 'datahen'
+require 'dh_easy/core/smart_collection'
+require 'dh_easy/core/exception'
+require 'dh_easy/core/plugin'
+require 'dh_easy/core/helper'
+require 'dh_easy/core/config'
+require 'dh_easy/core/mock'
+require 'dh_easy/core/version'
+module DhEasy
+  module Core
+    class << self
+      # Get dh_easy-core gem root directory path.
+      # @private
+      #
+      # @return [String]
+      def gem_root
+        File.expand_path File.join(File.dirname(__FILE__), '../..')
+      end
+      # Execute an action for all scripts within a directory.
+      #
+      # @param [String] dir Directory containing `.rb` scripts.
+      # @param [Hash] opts ({}) Configuration options.
+      # @option opts [Array] :except (nil) Literal file collection excluded from process.
+      #
+      # @yieldparam [String] path Script file path.
+      def all_scripts dir, opts = {}, &block
+        excluded_files = (opts[:except] || []).map{|f|File.expand_path File.join(dir, f)}
+        files = Dir[File.join(File.expand_path(dir), '*.rb')] - excluded_files
+        block ||= proc{}
+        files.sort.each &block
+      end
+      # Require all scripts within a directory.
+      #
+      # @param [String] dir Directory containing `.rb` scripts.
+      # @param [Hash] opts ({}) Configuration options.
+      # @option opts [Array] :except (nil) Literal file collection excluded from process.
+      def require_all dir, opts = {}
+        dir_list = real_dir_list = options = nil
+        real_except = (opts[:except] || []).map{|f| "#{f}.rb"}
+        options = opts.merge except: real_except
+        $LOAD_PATH.each do |load_path|
+          dir_list = Dir.glob File.join(load_path, dir)
+          dir_list.each do |real_dir|
+            next unless File.directory? real_dir
+            all_scripts(real_dir, options) {|file| require file}
+          end
+        end
+      end
+      # Require all relative scripts paths within a directory.
+      #
+      # @param [String] dir Directory containing `.rb` scripts.
+      # @param [Hash] opts ({}) Configuration options.
+      # @option opts [Array] :except (nil) Literal file collection excluded from process.
+      def require_relative_all dir, opts = {}
+        real_except = (opts[:except] || []).map{|f| "#{f}.rb"}
+        options = opts.merge except: real_except
+        dir_list = Dir.glob dir
+        dir_list.each do |relative_dir|
+          real_dir = File.expand_path relative_dir
+          all_scripts(real_dir, options) {|file| require file}
+        end
+      end
+      # Expose an environment into an object instance as methods.
+      #
+      # @param object Object instance to expose env into.
+      # @param [Array] env Hash with methods name as keys and blocks as actions.
+      #
+      # @return `object`
+      #
+      # @example
+      #   class Foo
+      #     def hello_person
+      #       'Hello person!'
+      #     end
+      #   end
+      #
+      #   env = {
+      #     hello_world: lambda{return 'Hello world!'},
+      #     hello_sky: proc{return 'Hello sky!'}
+      #   }
+      #   my_object = Foo.new
+      #   DhEasy::Core.expose_to my_object, env
+      #
+      #   puts my_object.hello_world
+      #   # => 'Hello world!'
+      #   puts my_object.hello_sky
+      #   # => 'Hello sky!'
+      #   puts my_object.hello_person
+      #   # => 'Hello person!'
+      def expose_to object, env
+        metaclass = class << object; self; end
+        env.each do |key, block|
+          metaclass.send(:define_method, key, block)
+        end
+        object
+      end
+      # Retrieve instance methods from an object.
+      #
+      # @param object Object with instance methods.
+      # @param class_only (false) Will get class only methods when `true`.
+      #
+      # @return [Array]
+      #
+      # @example
+      #   class Foo
+      #     def hello_world
+      #       'Hello world!'
+      #     end
+      #
+      #     def hello_person
+      #       'Hello person!'
+      #     end
+      #   end
+      #
+      #   my_object = Foo.new
+      #   DhEasy::Core.instance_methods_from my_object
+      #   # => [:hello_world, :hello_person]
+      def instance_methods_from object, class_only = false
+        object.methods(!class_only) - Object.new.methods(!class_only)
+      end
+      # Mock instances methods from the origin into target object.
+      #
+      # @param origin Object with instance methods to mock.
+      # @param target Object instance to mock methods into.
+      #
+      # @example
+      #   class Boo
+      #     attr_accessor :message
+      #     def initialize
+      #       message = 'Hello world!'
+      #     end
+      #
+      #     def hello_world
+      #       message
+      #     end
+      #   end
+      #
+      #   class Foo
+      #     def hello_person
+      #       'Hello person!'
+      #     end
+      #   end
+      #
+      #   origin = Boo.new
+      #   target = Foo.new
+      #   DhEasy::Core.mock_instance_methods origin target
+      #
+      #   puts target.hello_world
+      #   # => 'Hello world!'
+      #   puts target.hello_person
+      #   # => 'Hello person!'
+      #
+      #   origin.message = 'Hello world again!'
+      #   puts target.hello_world
+      #   # => 'Hello world again!'
+      def mock_instance_methods origin, target
+        # Get instance unique methods
+        method_list = instance_methods_from origin
+        method_list.delete :context_binding if method_list.include? :context_binding
+        # Build env reflecting origin unique methods
+        env = {}
+        method_list.each do |method|
+          env[method] = lambda{|*args|origin.send(method, *args)}
+        end
+        # Mock origin unique methods into target
+        expose_to target, env
+      end
+      # Generate a compatibility report from a origin and a fragment as a hash.
+      #
+      # @param [Array] origin Item collection to represent the universe.
+      # @param [Array] fragment Item collection to compare againt +origin+.
+      #
+      # @return [Hash]
+      #   * `:missing [Array]` (`[]`) Methods on `fragment` only.
+      #   * `:new [Array]` (`[]`) Methods on `origin` only.
+      #   * `:is_compatible [Boolean]` true when all `fragment`'s methods are present on `origin`.
+      #
+      # @example Analyze when uncompatible `fragment` because of `origin` missing fields.
+      #   DhEasy::Core.analyze_compatibility [1,2,3,4,5], [1,2,6]
+      #   # => {missing: [6], new: [3,4,5], is_compatible: false}
+      #
+      # @example Analyze when compatible.
+      #   DhEasy::Core.analyze_compatibility [1,2,3,4,5], [1,2,3]
+      #   # => {missing: [], new: [4,5], is_compatible: true}
+      def analyze_compatibility origin, fragment
+        intersection = origin & fragment
+        {
+          missing: fragment - intersection,
+          new: origin - intersection,
+          is_compatible: (intersection.count == fragment.count)
+        }
+      end
+      # Deep stringify keys from a hash.
+      #
+      # @param [Hash] hash Source hash to stringify keys.
+      # @param [Boolean] should_clone (true) Target a hash clone to avoid affecting the same hash object.
+      #
+      # @return [Hash]
+      def deep_stringify_keys hash, should_clone = true
+        return hash unless hash.is_a? Hash
+        pair_collection = hash.map{|k,v| [k.to_s,v]}
+        target = should_clone ? {} : hash
+        target.clear
+        pair_collection.each do |pair|
+          key, value = pair
+          if value.is_a? Array
+            array = []
+            value.each do |item|
+              array << deep_stringify_keys(item, should_clone)
+            end
+            target[key] = array
+            next
+          end
+          target[key] = deep_stringify_keys(value, should_clone)
+        end
+        target
+      end
+      # Deep stringify all keys on hash object.
+      #
+      # @param [Hash] hash Hash to stringify keys.
+      #
+      # @return [Hash]
+      def deep_stringify_keys! hash
+        deep_stringify_keys hash, false
+      end
+      # Deep clone a hash while keeping it's values object references.
+      #
+      # @param [Hash] hash Hash to clone.
+      # @param [Boolean] should_clone (false) Clone values when true.
+      #
+      # @return [Hash] Hash clone.
+      def deep_clone hash, should_clone = false
+        target = {}
+        hash.each do |key, value|
+          value = value.is_a?(Hash) ? deep_clone(value, should_clone) : (should_clone ? value.clone : value)
+          target[key] = value
+        end
+        target
+      end
+    end
+  end
+end

data/lib/dh_easy/core/config.rb ADDED Viewed

@@ -0,0 +1,27 @@
+module DhEasy
+  module Core
+    # Configuration manager tool useful for global configuration data accross
+    #   the scraping process.
+    class Config
+      include DhEasy::Core::Plugin::InitializeHook
+      include DhEasy::Core::Plugin::ConfigBehavior
+      # {DhEasy::Core::Plugin::ConfigBehavior#config_collection_key}
+      alias :collection_key :config_collection_key
+      # {DhEasy::Core::Plugin::ConfigBehavior#config_collection}
+      alias :collection :config_collection
+      # Initialize config object
+      #
+      # @param [Hash] opts ({}) Configuration options.
+      #
+      # @see DhEasy::Core::Plugin::ConfigBehavior#initialize_hook_core_config_behavior
+      def initialize opts = {}
+        opts = opts.merge(
+          config_collection: opts[:collection]
+        )
+        initialize_hooks opts
+      end
+    end
+  end
+end

data/lib/dh_easy/core/exception.rb ADDED Viewed

@@ -0,0 +1,8 @@
+require 'dh_easy/core/exception/outdated_error'
+module DhEasy
+  module Core
+    module Exception
+    end
+  end
+end

data/lib/dh_easy/core/exception/outdated_error.rb ADDED Viewed

@@ -0,0 +1,9 @@
+module DhEasy
+  module Core
+    module Exception
+      # Exception that indicates something is outdated error.
+      class OutdatedError < StandardError
+      end
+    end
+  end
+end

data/lib/dh_easy/core/helper.rb ADDED Viewed

@@ -0,0 +1,8 @@
+require 'dh_easy/core/helper/cookie'
+module DhEasy
+  module Core
+    module Helper
+    end
+  end
+end

data/lib/dh_easy/core/helper/cookie.rb ADDED Viewed

@@ -0,0 +1,209 @@
+module DhEasy
+  module Core
+    module Helper
+      # Helper used for lower level cookie management.
+      class Cookie
+        class << self
+          # Parse request cookies on different formats.
+          #
+          # @param [String,Hash,Array] cookies Cookies to parse.
+          # @param [Hash] cookie_hash ({}) External hash to store parsed cookies.
+          #
+          # @return [Hash]
+          #
+          # @example Parse from string.
+          #   parse_from_request 'aaa=111; bbb=222'
+          #   # => {'aaa' => 111, 'bbb' => 222}
+          #
+          # @example Parse from array.
+          #   cookies = [
+          #     'aaa=111',
+          #     'bbb=222'
+          #   ]
+          #   parse_from_response cookies
+          #   # => {'aaa' => 111, 'bbb' => 222}
+          #
+          # @example Parse with `cookie_hash`.
+          #   cookie_hash = {'ccc' => 333}
+          #   parse_from_request 'aaa=111; bbb=222', cookie_hash
+          #   cookie_hash
+          #   # => {'aaa' => 1, 'bbb' => 2, 'ccc' => 333}
+          def parse_from_request cookies, cookie_hash = {}
+            # Retrieve from hash
+            if cookies.is_a? Hash
+              cookie_hash.merge! cookies
+              return cookie_hash
+            end
+            # Extract from string
+            cookies = cookies.split '; ' if cookies.is_a? String
+            # Extract from array
+            cookies&.each do |raw_cookie|
+              key, value = raw_cookie.split('=', 2)
+              cookie_hash[key] = value
+            end
+            cookie_hash
+          end
+          # Parse response cookies on different formats.
+          #
+          # @param [String,Hash,Array] cookies Cookies to parse.
+          # @param [Hash] cookie_hash ({}) External hash to store parsed cookies.
+          #
+          # @return [Hash]
+          #
+          # @example Parse from string
+          #   parse_from_response 'aaa=111; bbb=222'
+          #   # => {'aaa' => 111, 'bbb' => 222}
+          #
+          # @example Parse from array.
+          #   cookies = [
+          #     'aaa=111; Expires=Thu, Jan 01 1970 00:00:00 UTC; path=/',
+          #     'bbb=222; path=/',
+          #     'ccc=333; path=/; expires=Wed, Jan 01 3000 00:00:00 UTC'
+          #   ]
+          #   parse_from_response cookies
+          #   # => {'bbb' => 222, 'ccc' => 333}
+          #
+          # @example Parse with `cookie_hash`.
+          #   cookie_hash = {'ccc' => 333}
+          #   parse_from_response 'aaa=111; bbb=222', cookie_hash
+          #   cookie_hash
+          #   # => {'aaa' => 111, 'bbb' => 222, 'ccc' => 333}
+          def parse_from_response cookies, cookie_hash = {}
+            # Retrieve from hash
+            if cookies.is_a? Hash
+              cookie_hash.merge! cookies
+              return cookie_hash
+            end
+            # Retrieve from String
+            cookies = cookies.split '; ' if cookies.is_a? String
+            # Extract from array
+            info = cookie = expires = key = value = nil
+            cookies&.each do |raw_cookie|
+              # Extract cookie data
+              key_pair = raw_cookie.scan(/(?:;\s+([^\=]+)=([^;]*))/i) || []
+              cookie = key_pair.inject(Hash.new){|h,i|h[i[0].to_s.downcase] = i[1]; h}
+              cookie[:key], cookie[:value] = raw_cookie.match(/^\s*(?<key>[^\=]+)\=(?<value>[^;]*)/i)&.captures
+              # Check cookie expire
+              expires = cookie['expires'].nil? ? nil : Time.parse(cookie['expires'])
+              if !expires.nil? && Time.now > expires
+                cookie_hash.delete cookie[:key]
+                next
+              end
+              # Save cookie
+              cookie_hash[cookie[:key]] = cookie[:value]
+            end
+            cookie_hash
+          end
+          # Apply request and response cookies as a hash.
+          #
+          # @param [String,Array,Hash] request_cookies Cookies to parse.
+          # @param [String,Array,Hash] response_cookies Cookies to parse.
+          #
+          # @return [Hash]
+          #
+          # @example
+          #   request_cookies = 'aaa=111; ddd=444'
+          #   response_cookies = [
+          #     'aaa=111; Expires=Thu, Jan 01 1970 00:00:00 UTC; path=/',
+          #     'bbb=222; path=/',
+          #     'ccc=333; path=/; expires=Wed, Jan 01 3000 00:00:00 UTC'
+          #   ]
+          #   update_as_hash , response_cookies
+          #   # => {'bbb' => 222, 'ccc' => 333, 'ddd' => 444}
+          def update_as_hash request_cookies, response_cookies
+            cookie_hash = {}
+            parse_from_request request_cookies, cookie_hash
+            parse_from_response response_cookies, cookie_hash
+            cookie_hash
+          end
+          # Encode cookies as request cookie string.
+          #
+          # @param [Hash] cookie_hash Hash with cookies.
+          #
+          # @return [String]
+          #
+          # @example
+          #   cookie_hash = {
+          #     'aaa' => 111,
+          #     'bbb' => 222
+          #   }
+          #   encode_to_header cookie_hash
+          #   # => 'aaa=111; bbb=222'
+          def encode_to_header cookie_hash
+            cookie_hash.map{|k,v| "#{k}=#{v}"}.join '; '
+          end
+          # Apply request and response cookies as a string with request format.
+          #
+          # @param [String,Array,Hash] request_cookies Cookies to parse.
+          # @param [String,Array,Hash] response_cookies Cookies to parse.
+          #
+          # @return [String]
+          #
+          # @example
+          #   request_cookies = 'aaa=111; ddd=444'
+          #   response_cookies = [
+          #     'aaa=111; Expires=Thu, Jan 01 1970 00:00:00 UTC; path=/',
+          #     'bbb=222; path=/',
+          #     'ccc=333; path=/; expires=Wed, Jan 01 3000 00:00:00 UTC'
+          #   ]
+          #   update_as_hash , response_cookies
+          #   # => 'bbb=222; ccc=333; ddd=444'
+          def update request_cookies, response_cookies
+            cookie_hash = update_as_hash request_cookies, response_cookies
+            encode_to_header cookie_hash
+          end
+          # Compare if cookie is included into base cookie
+          #
+          # @param [Hash] base_cookie_hash Hash that represent universe.
+          # @param [Hash] cookie_hash Hash that represents to compare.
+          #
+          # @return [Boolean]
+          #
+          # @example Check a success match.
+          #   base_cookie_hash = {
+          #     'aaa' => 111,
+          #     'bbb' => 222,
+          #     'ccc' => 333,
+          #     'ddd' => 444
+          #   }
+          #   cookie_hash = {
+          #     'bbb' => 222,
+          #     'ddd' => 444
+          #   }
+          #   include? base_cookie_hash, cookie_hash
+          #   # => true
+          #
+          # @example Check with fail match.
+          #   base_cookie_hash = {
+          #     'aaa' => 111,
+          #     'bbb' => 222,
+          #     'ccc' => 333,
+          #     'ddd' => 444
+          #   }
+          #   cookie_hash = {
+          #     'bbb' => 555,
+          #     'ddd' => 444
+          #   }
+          #   include? base_cookie_hash, cookie_hash
+          #   # => false
+          def include? base_cookie_hash, cookie_hash
+            cookie_hash.each do |key, value|
+              return false unless base_cookie_hash.has_key?(key) && base_cookie_hash[key] == value
+            end
+            true
+          end
+        end
+      end
+    end
+  end
+end