ae_easy-router 0.0.1

data/lib/ae_easy/router.rb

@@ -0,0 +1,13 @@
+require 'yaml'
+require 'ae_easy/core'
+require 'ae_easy/config'
+require 'ae_easy_override/core'
+require 'ae_easy/router/version'
+require 'ae_easy/router/plugin'
+require 'ae_easy/router/parser'
+require 'ae_easy/router/seeder'
+
+module AeEasy
+  module Router
+  end
+end

data/lib/ae_easy/router/parser.rb

@@ -0,0 +1,48 @@
+module AeEasy
+  module Router
+    # Parser router designed to look over page_type for route to the right
+    #   parser class.
+    class Parser
+      include AeEasy::Router::Plugin::Router
+
+      # Execute the parser class with options as described by router
+      #   configuration filtering by `page_type` and calling class's instance
+      #   `parse` method.
+      #
+      # @param [Hash] opts ({}) Parser initializer options (see
+      #   AeEasy::Core::Plugin::Parser).
+      #
+      # @raise [ArgumentError] `opts[:context]` is `nil`.
+      # @raise [ArgumentError] `page_type` doesn't exists within routes.
+      # @raise [NameError] A class with name equal to route's `class` attribute
+      #   doesn't exists.
+      #
+      # @note Requires the route class to implement `parse` instance method.
+      def route opts = {}
+        context = opts[:context]
+        if context.nil?
+          raise ArgumentError.new('Must send a context to the parser.')
+        end
+
+        page_type = context.page['page_type'].strip.downcase
+        class_name = nil
+        config['parser']['routes'].each do |item|
+          # Look for page type
+          next if item['page_type'].strip.downcase != page_type
+
+          # Validate class name
+          executor_class = get_class item['class']
+          if executor_class.nil?
+            raise NameError.new("Class \"#{item['class']}\" doesn't exists, check your ae_easy config file.")
+          end
+
+          executor_class.new(opts).parse
+          return
+        end
+
+        # Page type is not routed, raise an error.
+        raise ArgumentError.new("Page type \"#{page_type}\" is not routed, check your ae_easy config file.")
+      end
+    end
+  end
+end

data/lib/ae_easy/router/plugin.rb

@@ -0,0 +1,8 @@
+require 'ae_easy/router/plugin/router'
+
+module AeEasy
+  module Router
+    module Plugin
+    end
+  end
+end

data/lib/ae_easy/router/plugin/router.rb

@@ -0,0 +1,74 @@
+module AeEasy
+  module Router
+    module Plugin
+      # Base router providing the basic functionalities from a router.
+      module Router
+        include AeEasy::Core::Plugin::InitializeHook
+
+        # Local configuration (see AeEasy::Core::Config).
+        attr_reader :local_config
+
+        # Hook to initialize router configuration.
+        #
+        # @param [Hash] opts ({}) Configuration options.
+        # @option opts [AeEasy::Config::Local,nil] :config (nil) Configuration to
+        #   use.
+        # @option opts [String] :config_file_path (nil) Configuration file to
+        #   load when no +:config+ was provided (see
+        #   AeEasy::Core::Config#file_path for default file).
+        # @option opts [Boolean] :force (false) Will reload configuration file
+        #   when `true`.
+        #
+        # @note `opts[:config]` will be prioritize over
+        #   `opts[:config_file_path]` and `opts[:force]`.
+        def initialize_hook_router_plugin_router opts = {}
+          opts = {
+            config: nil,
+            config_file_path: nil,
+            force: false
+          }.merge opts
+          @local_config = opts[:config]
+          @local_config ||= AeEasy::Config::Local.new(
+            file_path: opts[:config_file_path],
+            force: opts[:force]
+          )
+        end
+
+        # Initialize router and hooks.
+        #
+        # @param [Hash] opts ({}) Configuration options.
+        #
+        # @see #initialize_hook_router_plugin_router
+        def initialize opts = {}
+          initialize_hooks opts
+        end
+
+        # Router configuration.
+        #
+        # @return [Hash]
+        def config
+          local_config['router']
+        end
+
+        # Validates when a class name exists
+        #
+        # @param [String] name Class name to validate.
+        #
+        # @return [Boolean] `true` when exists, else `false`.
+        def class_defined? name
+          Object.const_defined? name
+        end
+
+        # Get a class from a class name.
+        #
+        # @param [String] name Class name to validate.
+        #
+        # @return [Class,nil] `nil` when class doesn't exists.
+        def get_class name
+          return nil unless class_defined? name
+          Object.const_get name
+        end
+      end
+    end
+  end
+end

data/lib/ae_easy/router/seeder.rb

@@ -0,0 +1,38 @@
+module AeEasy
+  module Router
+    # Seeder router designed to execute all seeders classes.
+    class Seeder
+      include AeEasy::Router::Plugin::Router
+
+      # Execute the seeder class with options as described by router
+      #   configuration and calling class's instance `seed` method.
+      #
+      # @param [Hash] opts ({}) Seeder initializer options (see
+      #   AeEasy::Core::Plugin::Seeder).
+      #
+      # @raise [ArgumentError] `opts[:context]` is `nil`.
+      # @raise [ArgumentError] `page_type` doesn't exists within routes.
+      # @raise [NameError] A class with name equal to route's `class` attribute
+      #   doesn't exists.
+      #
+      # @note Requires the route class to implement `seed` instance method.
+      def route opts = {}
+        context = opts[:context]
+        if opts[:context].nil?
+          raise ArgumentError.new('Must send a context to the seeder.')
+        end
+
+        class_name = nil
+        config['seeder']['routes'].each do |item|
+          # Validate class name
+          executor_class = get_class item['class']
+          if executor_class.nil?
+            raise NameError.new("Class \"#{item['class']}\" doesn't exists, check your ae_easy config file.")
+          end
+
+          executor_class.new(opts).seed
+        end
+      end
+    end
+  end
+end

data/lib/ae_easy/router/version.rb

@@ -0,0 +1,6 @@
+module AeEasy
+  module Router
+    # Gem version
+    VERSION = "0.0.1"
+  end
+end

data/lib/ae_easy_override/core.rb

@@ -0,0 +1,6 @@
+require 'ae_easy/core/plugin'
+
+module AeEasy
+  module Core
+  end
+end

data/lib/ae_easy_override/core/plugin.rb

@@ -0,0 +1,9 @@
+require 'ae_easy/core/plugin/seeder_behavior'
+require 'ae_easy/core/plugin/parser_behavior'
+
+module AeEasy
+  module Core
+    module Plugin
+    end
+  end
+end

data/lib/ae_easy_override/core/plugin/parser_behavior.rb

@@ -0,0 +1,11 @@
+module AeEasy
+  module Core
+    module Plugin
+      module ParserBehavior
+        def parse
+          raise NotImplementedError.new('Must implement "parse" method.')
+        end
+      end
+    end
+  end
+end

data/lib/ae_easy_override/core/plugin/seeder_behavior.rb

@@ -0,0 +1,11 @@
+module AeEasy
+  module Core
+    module Plugin
+      module SeederBehavior
+        def seed
+          raise NotImplementedError.new('Must implement "seed" method.')
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,216 @@
+--- !ruby/object:Gem::Specification
+name: ae_easy-router
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Eduardo Rosales
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-02-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ae_easy-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ae_easy-config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.16.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.16.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.11'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: AnswersEngine Easy toolkit router module allow an easier class integration,
+  useful on advance implementations.
+email:
+- eduardo@datahen.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- ".yardopts"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- ae_easy-router.gemspec
+- doc/AeEasy.html
+- doc/AeEasy/Core.html
+- doc/AeEasy/Core/Plugin.html
+- doc/AeEasy/Core/Plugin/ParserBehavior.html
+- doc/AeEasy/Core/Plugin/SeederBehavior.html
+- doc/AeEasy/Router.html
+- doc/AeEasy/Router/Parser.html
+- doc/AeEasy/Router/Plugin.html
+- doc/AeEasy/Router/Plugin/Router.html
+- doc/AeEasy/Router/Seeder.html
+- doc/_index.html
+- doc/class_list.html
+- doc/css/common.css
+- doc/css/full_list.css
+- doc/css/style.css
+- doc/file.README.html
+- doc/file_list.html
+- doc/frames.html
+- doc/index.html
+- doc/js/app.js
+- doc/js/full_list.js
+- doc/js/jquery.js
+- doc/method_list.html
+- doc/top-level-namespace.html
+- lib/ae_easy/router.rb
+- lib/ae_easy/router/parser.rb
+- lib/ae_easy/router/plugin.rb
+- lib/ae_easy/router/plugin/router.rb
+- lib/ae_easy/router/seeder.rb
+- lib/ae_easy/router/version.rb
+- lib/ae_easy_override/core.rb
+- lib/ae_easy_override/core/plugin.rb
+- lib/ae_easy_override/core/plugin/parser_behavior.rb
+- lib/ae_easy_override/core/plugin/seeder_behavior.rb
+homepage: https://answersengine.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://answersengine.com
+  source_code_uri: https://github.com/answersengine/ae_easy-router
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: AnswersEngine Easy toolkit router module
+test_files: []