eco-helpers 0.6.17 → 0.7.1

data/lib/eco/api/usecases/use_case_io.rb

@@ -0,0 +1,117 @@
+module Eco
+  module API
+    module UseCases
+      class UseCaseIO
+        TYPES      = [:import, :filter, :transform, :sync, :export]
+        ALL_PARAMS = [:input, :people, :session, :options]
+        TYPE_PARAMS = {
+          import:    [:input, :session],
+          filter:    [:people, :session, :options],
+          transform: [:people, :session],
+          export:    [:people, :session, :options]
+        }
+
+        attr_reader :usecase
+        attr_reader :input, :people, :session, :options
+        attr_accessor :output
+
+        class << self
+          def valid_type?(type)
+            TYPES.include?(type)
+          end
+
+          def type_params(type)
+            raise "Invalid type '#{type.to_s}'" if !valid_type?(type)
+            TYPE_PARAMS[type]
+          end
+        end
+
+        def initialize(input: nil, people: nil, session:, options: {}, usecase:)
+          self.usecase = usecase
+          @output      = nil
+
+          validate_args(input: input, people: people, session: session, options: options)
+
+          @input       = input
+          @people      = people
+          @session     = session
+          @options     = options
+        end
+
+        def usecase=(value)
+          raise "It should be a UseCase. Given: #{value}" if !value.is_a?(UseCase)
+          @usecase = value
+        end
+
+        def type
+          @usecase.type
+        end
+
+        def params(input: nil, people: nil, session: nil, options: {}, keyed: false)
+          opts      = @options.merge(options&.dup || {})
+          input   ||= @input
+          people  ||= @people
+          session ||= @session
+
+          kargs = {}
+          kargs.merge!(input:    input)  if input_required?
+          kargs.merge!(people:  people)  if people_required?
+          kargs.merge!(session: session, options: opts)
+          keyed ? kargs : kargs.values
+        end
+
+        def chain(usecase:)
+          raise "It should be a UseCase. Given: #{usecase}" if !usecase.is_a?(UseCase)
+
+          kargs = params(keyed: true)
+
+          # TODO: review chaining framework (redirection should depend on self.type as well)
+          case usecase.type
+          when :import
+            kargs[:input]  = output
+          when :filter
+            kargs[:people] = output
+          when :transform, :sync, :export
+            # no redirections => should it redirect the input?
+          end
+
+          self.class.new(kargs)
+        end
+
+        protected
+
+        private
+
+        def validate_args(input:, people:, session:, options:)
+          case
+          when !session.is_a?(Eco::API::Session)
+            raise "A UseCase needs a Session object. Given: #{session}"
+          when input_required? && !input
+            raise "UseCase of type '#{@type.to_s}' requires a valid input. None given"
+          when people_required? && !people.is_a?(Eco::API::Organization::People)
+            raise "UseCase of type '#{@type.to_s}' requires a People object. Given: #{people}"
+          when !options || (options && !options.is_a?(Hash))
+            raise "To inject dependencies via ':options' it should be a Hash object. Given: #{options}"
+          when options_required? && !options
+            raise "UseCase of type '#{@type.to_s}' requires a Hash ':options' object."
+          end
+          true
+        end
+
+        def input_required?
+          [:import, :sync].include?(type)
+        end
+
+        def people_required?
+          [:filter, :transform, :sync, :export].include?(type)
+        end
+
+        def options_required?
+          [:filter].include?(type)
+        end
+
+      end
+
+    end
+  end
+end

data/lib/eco/api/usecases/use_group.rb

@@ -2,10 +2,11 @@ module Eco
   module API
     module UseCases
       class UseGroup
+        include Enumerable
 
         def initialize()
-          @usecases     = {}
-          @cache_init   = false
+          @usecases      = {}
+          @cache_init    = false
           @cases_by_name = {}
         end
 
@@ -20,7 +21,9 @@ module Eco
         end
 
         def define(name, type:, &block)
-          add(UseCase.new(name, type: type, root:self, &block))
+          UseCase.new(name, type: type, root: self, &block).tap do |usecase|
+            add(usecase)
+          end
         end
 
         def defined?(name, type: nil)
@@ -54,7 +57,7 @@ module Eco
         def merge(cases)
           return self if !cases
           raise "Expected a UseGroup object. Given #{cases}" if !cases.is_a?(UseGroup)
-          cases_hash = cases.hash
+          cases_hash = cases.to_h
 
           @usecases.merge!(cases_hash)
 
@@ -66,9 +69,26 @@ module Eco
           self
         end
 
+        def length
+          count
+        end
+
+        def empty?
+          count == 0
+        end
+
+        def each(params: {}, &block)
+          return to_enum(:each) unless block
+          items.each(&block)
+        end
+
+        def items
+          @usecases.values
+        end
+        
         protected
 
-        def hash
+        def to_h
           @usecases
         end
 

data/lib/eco/common/base_cli_backup.rb

@@ -63,6 +63,7 @@ module Eco
           if options
             options.key?("input") || options.key?(:input) ||
             options.key?("json") ||  options.key?(:json)
+          end
         end
 
         def input_object(input)

data/lib/eco/language/models.rb

@@ -7,5 +7,5 @@ end
 
 require_relative 'models/modifier'
 require_relative 'models/collection'
-require_relative 'models/attribute_parser'
+require_relative 'models/parser_serializer'
 require_relative 'models/wrap'

data/lib/eco/language/models/collection.rb

@@ -1,9 +1,10 @@
 module Eco
   module Language
     module Models
-      class Collection < Array
+      class Collection
+        include Enumerable
 
-        ATTR_PRESENCE_METHODS = ["present", "empty", "present_all?", "present_some?"]
+        ATTR_PRESENCE_METHODS =   ["present", "empty", "present_all?", "present_some?"]
         ATTR_COLLECTION_METHODS = ["exclude", "remove", "attr", "attr?", "attrs", "unique_attrs", "contains"] + ATTR_PRESENCE_METHODS
 
         class << self
@@ -34,14 +35,14 @@ module Eco
 
         end
 
-        #attr_reader :kclass
+        #attr_reader :items
 
         def initialize(data = [], klass:, factory: nil, handy: Eco::Common::Language.new)
           raise "Raise klass required, given: #{klass}" if !klass
           @klass   = klass
           @factory = factory
           @handy   = handy
-          super(to_klass(data))
+          @items   = to_klass(data)
         end
 
         def newFrom(data)
@@ -53,17 +54,29 @@ module Eco
         end
 
         def new
-          self.class.new(self.to_a, klass: @klass, factory: @factory)
+          self.class.new(to_a, klass: @klass, factory: @factory)
+        end
+
+        def length
+          count
+        end
+
+        def empty?
+          count == 0
+        end
+
+        def each(params: {}, &block)
+          return to_enum(:each) unless block
+          @items.each(&block)
         end
 
         def <(value)
-          self.clear << value
-          on_change
-          self
+          @items.clear
+          self << value
         end
 
         def <<(value)
-          self.concat(into_a(value))
+          @items.concat(into_a(value))
           on_change
           self
         end
@@ -72,28 +85,26 @@ module Eco
           newFrom self.map(&block)
         end
 
-        def delete(value)
-          self < self - value
-          on_change
-          self
+        def delete!(value)
+          self < @items - into_a(value)
         end
 
         # attr dependant methods
         def exclude(attr, value, modifier = Language::MatchModifier.new)
-          newFrom self - self.attr(attr, value, modifier)
+          newFrom @items - self.attr(attr, value, modifier)
         end
 
         def remove(attr, value, modifier = Language::MatchModifier.new)
-          self < self.exclude(attr, value, modifier)
+          self < exclude(attr, value, modifier)
           on_change
           self
         end
 
         def attr(attr, value = true, modifier = Language::MatchModifier.new)
           if !!value == value # boolean?
-            self.present(attr, value)
+            present(attr, value)
           else
-            return newFrom self.select { |object|
+            return newFrom select { |object|
               attr_val = fetch_attr(object, attr)
               match?(attr_val, value, modifier)
             }
@@ -103,36 +114,36 @@ module Eco
         def attr?(attr, value = true, modifier = Language::MatchModifier.new)
           modifier = modifier.new.reverse
           if !!value == value # boolean?
-            self.present(attr, value).length == self.length
+            present(attr, value).length == length
           else
-            obj_vals = self.attrs(attr)
+            obj_vals = attrs(attr)
             return match?(obj_vals, value, modifier)
           end
         end
 
         def attrs(attr)
-          self.map { |object| fetch_attr(object, attr) }
+          map { |object| fetch_attr(object, attr) }
         end
 
         def unique_attrs(attr)
-          self.to_h(attr).keys
+          to_h(attr).keys
         end
 
         def present(attr, flag = true)
           block = ->(o) { !!fetch_attr(o, attr) == !!flag }
-          newFrom self.select(&block)
+          newFrom select(&block)
         end
 
         def empty(attr, flag = true)
-          self.present(attr, !flag)
+          present(attr, !flag)
         end
 
         def present_all?(attr, flag = true)
-          self.present(attr, flag).length == self.length
+          present(attr, flag).length == length
         end
 
         def present_some?(attr, flag = true)
-          self.present(attr, flag).length > 0
+          present(attr, flag).length > 0
         end
 
         def contains(attr, value, modifier = Language::MatchModifier.new)
@@ -141,14 +152,14 @@ module Eco
         end
 
         def group_by(attr)
-          #self.to_h(attr)
-          return {} if !attr
-          self.to_a.group_by { |object| object.method(attr).call }
+          to_h(attr)
+          #return {} if !attr
+          #self.to_a.group_by { |object| object.method(attr).call }
         end
 
         def to_h(attr)
           return {} if !attr
-          self.to_a.group_by { |object| object.method(attr).call }
+          to_a.group_by { |object| object.method(attr).call }
         end
 
         protected
@@ -158,8 +169,8 @@ module Eco
         end
 
         def into_a(value)
-          value = [].push(value) unless value.is_a?(Array)
-          value
+          value = [].push(value) unless value.is_a?(Enumerable)
+          value.to_a
         end
 
         private

data/lib/eco/language/models/parser_serializer.rb

@@ -0,0 +1,68 @@
+module Eco
+  module Language
+    module Models
+
+      class ParserSerializer
+
+        attr_reader :attr
+
+        # Parser/seralizer.
+        # @param attr [String, Symbol] name of the parsed/serialized.
+        # @param dependencies [Hash] provisioning of _**default dependencies**_ that will be required when calling back to the
+        # parsing or serializing functions.
+        def initialize(attr, dependencies: {})
+          @attr = attr
+          @dependencies = dependencies
+        end
+
+        # Defines the _parser_ of the attribute.
+        # @note
+        #   1. the _block_ should expect one or two parameters.
+        #   2. the final dependencies is a merge of _default dependencies_ with `parse` call dependencies.
+        # @yield [source_data, dependencies] user defined parser that returns the parsed value.
+        # @yieldparam source_data [Any] source data that will be parsed.
+        # @yieldparam dependencies [Hash] hash with the provisioned dependencies.
+        def def_parser(&block)
+          @parser = block
+          self
+        end
+
+        # Defines the _serializer_ of the attribute.
+        # @note
+        #   1. the block should expect one or two parameters.
+        #   2. the final dependencies is a merge of _default dependencies_ with `serialize` call dependencies.
+        # @yield [source_data, dependencies] user defined serialiser that returns the serialised value.
+        # @yieldparam source_data [Any] source data that will be serialised.
+        # @yieldparam dependencies [Hash] hash with the provisioned dependencies.
+        def def_serializer(&block)
+          @serializer = block
+          self
+        end
+
+        # Calls the `parser` of this attribute by passing `source` and resolved dependencies.
+        # @note
+        #   - the method depenencies override keys of the _default dependencies_.
+        # @raise [Exception] when there is **no** `parser` defined.
+        # @param source [Any] source data to be parsed.
+        # @param dependencies [Hash] _additional dependencies_ that should be merged to the _default dependencies_.
+        def parse(source, dependencies: {})
+          raise "There is no parser for this attribue '#{attr}'" if !@parser
+          @parser.call(source, @dependencies.merge(dependencies), attr)
+        end
+
+        # Calls the `serializer` of this attribute by passing `object` and resolved dependencies.
+        # @note
+        #   - the method depenencies override keys of the _default dependencies_.
+        # @raise [Exception] when there is **no** `serializer` defined.
+        # @param object [Any] source data to be serialized.
+        # @param dependencies [Hash] _additional dependencies_ that should be merged to the _default dependencies_.
+        def serialize(object, dependencies: {})
+          raise "There is no serializer for this attribue '#{attr}'" if !@serializer
+          @serializer.call(object, @dependencies.merge(dependencies), attr)
+        end
+
+      end
+
+    end
+  end
+end

data/lib/eco/version.rb

@@ -1,3 +1,3 @@
 module Eco
-  VERSION = "0.6.17"
+  VERSION = "0.7.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eco-helpers
 version: !ruby/object:Gem::Version
-  version: 0.6.17
+  version: 0.7.1
 platform: ruby
 authors:
 - Oscar Segura
@@ -10,6 +10,20 @@ bindir: bin
 cert_chain: []
 date: 2018-09-05 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -30,6 +44,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.8'
+- !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: yard
   requirement: !ruby/object:Gem::Requirement
@@ -91,65 +119,45 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.4.2
 - !ruby/object:Gem::Dependency
-  name: faker
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.9'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.9'
-- !ruby/object:Gem::Dependency
-  name: distribution
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.3
+        version: '0.20'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.3
+        version: '0.20'
 - !ruby/object:Gem::Dependency
-  name: thor
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.20'
+        version: 1.6.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.20'
+        version: 1.6.8
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3
   requirement: !ruby/object:Gem::Requirement
@@ -210,6 +218,46 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: distribution
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.3
 description: 
 email:
 - oscar@ecoportal.co.nz
@@ -220,7 +268,9 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".yardopts"
+- Gemfile
 - README.md
+- Rakefile
 - eco-helpers.gemspec
 - lib/eco-helpers.rb
 - lib/eco/api.rb
@@ -229,6 +279,7 @@ files:
 - lib/eco/api/common/people/base_parser.rb
 - lib/eco/api/common/people/default_parsers.rb
 - lib/eco/api/common/people/default_parsers/boolean_parser.rb
+- lib/eco/api/common/people/default_parsers/csv_parser.rb
 - lib/eco/api/common/people/default_parsers/date_parser.rb
 - lib/eco/api/common/people/default_parsers/multi_parser.rb
 - lib/eco/api/common/people/default_parsers/numeric_parser.rb
@@ -236,10 +287,10 @@ files:
 - lib/eco/api/common/people/entries.rb
 - lib/eco/api/common/people/entry_factory.rb
 - lib/eco/api/common/people/person_entry.rb
+- lib/eco/api/common/people/person_entry_attribute_mapper.rb
 - lib/eco/api/common/people/person_factory.rb
 - lib/eco/api/common/people/person_modifier.rb
 - lib/eco/api/common/people/person_parser.rb
-- lib/eco/api/common/people/types.rb
 - lib/eco/api/common/session.rb
 - lib/eco/api/common/session/base_session.rb
 - lib/eco/api/common/session/environment.rb
@@ -253,12 +304,17 @@ files:
 - lib/eco/api/eco_faker.rb
 - lib/eco/api/organization.rb
 - lib/eco/api/organization/people.rb
+- lib/eco/api/organization/person_schemas.rb
 - lib/eco/api/organization/policy_groups.rb
 - lib/eco/api/organization/preferences.rb
 - lib/eco/api/organization/preferences_reference.json
-- lib/eco/api/organization/presets.rb
+- lib/eco/api/organization/presets_factory.rb
 - lib/eco/api/organization/presets_values.json
 - lib/eco/api/organization/tag_tree.rb
+- lib/eco/api/policies.rb
+- lib/eco/api/policies/base_policy.rb
+- lib/eco/api/policies/policy.rb
+- lib/eco/api/policies/used_policies.rb
 - lib/eco/api/session.rb
 - lib/eco/api/session/batch.rb
 - lib/eco/api/session/batch_job.rb
@@ -271,13 +327,13 @@ files:
 - lib/eco/api/session/config/logger.rb
 - lib/eco/api/session/config/mailer.rb
 - lib/eco/api/session/config/people.rb
+- lib/eco/api/session/config/policies.rb
 - lib/eco/api/session/config/s3_storage.rb
 - lib/eco/api/session/config/use_cases.rb
 - lib/eco/api/session/job_groups.rb
 - lib/eco/api/session/task.rb
 - lib/eco/api/usecases.rb
 - lib/eco/api/usecases/base_case.rb
-- lib/eco/api/usecases/case_data.rb
 - lib/eco/api/usecases/default_cases.rb
 - lib/eco/api/usecases/default_cases/change_email_case.rb
 - lib/eco/api/usecases/default_cases/create_case.rb
@@ -302,6 +358,8 @@ files:
 - lib/eco/api/usecases/default_cases/update_details_case.rb
 - lib/eco/api/usecases/default_cases/upsert_case.rb
 - lib/eco/api/usecases/use_case.rb
+- lib/eco/api/usecases/use_case_chain.rb
+- lib/eco/api/usecases/use_case_io.rb
 - lib/eco/api/usecases/use_group.rb
 - lib/eco/cli.rb
 - lib/eco/cli/api.rb
@@ -340,14 +398,11 @@ files:
 - lib/eco/language/match.rb
 - lib/eco/language/match_modifier.rb
 - lib/eco/language/models.rb
-- lib/eco/language/models/attribute_parser.rb
 - lib/eco/language/models/collection.rb
 - lib/eco/language/models/modifier.rb
+- lib/eco/language/models/parser_serializer.rb
 - lib/eco/language/models/wrap.rb
 - lib/eco/language/values_at.rb
-- lib/eco/lexic/dictionary.rb
-- lib/eco/lexic/dictionary/dictionary.txt
-- lib/eco/lexic/dictionary/tags.json
 - lib/eco/scripting.rb
 - lib/eco/scripting/README.md
 - lib/eco/scripting/arguments.rb