legatus 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fd9586b50f1209e599a2c6da395c11a0be0926bee165f0d0a1046330cf844ed1
+  data.tar.gz: ad18c8452d8f52170fc04880f6d0370e6af3f956faa49bb1ba6021d13f502d83
+SHA512:
+  metadata.gz: 226fa1d9f2d5f3168bbe4cdd3420513ceeeac36434490166555990eac2a44bed98dab8e81075fbdb85bb10f31cf90743abe9761432665261d4f0c6f57c590aa4
+  data.tar.gz: 89eef7866335b9ef6dcaea661f85643087f430e81cb8fd2a28b3bd73897080cfd34bbbe50210581696a05b922df15e4f45f145d81e3ec997d18222e4cca2aa26

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 rcpedro
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,28 @@
+# Legatus
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'legatus'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install legatus
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Legatus'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/legatus.rb

@@ -0,0 +1,11 @@
+require 'legatus/railtie'
+require 'legatus/extensions/hash'
+require 'legatus/chain'
+require 'legatus/repository'
+require 'legatus/unit_of_work'
+require 'legatus/directive'
+
+
+module Legatus
+  # Your code goes here...
+end

data/lib/legatus/chain.rb

@@ -0,0 +1,24 @@
+module Legatus
+  class Chain
+    attr_reader :invocations
+
+    def initialize(invocations)
+      @invocations = invocations
+    end
+
+    def apply(source)
+      result = source
+      @invocations.each do |name, params|
+        break if result.nil?
+        
+        if params.is_a?(Proc)
+          result = result.send(name, &params)
+        else
+          result = result.send(name, *params)
+        end
+      end
+
+      return result
+    end
+  end
+end

data/lib/legatus/directive.rb

@@ -0,0 +1,179 @@
+require 'flexcon'
+
+
+module Legatus
+  class Directive
+    extend ActiveModel::Naming
+
+    class << self
+      attr_reader :properties, 
+                  :models, 
+                  :validations,
+                  :transactions,
+                  :callbacks
+      
+      def props
+        schema = yield
+
+        @properties = {}
+        schema.each do |key, invocations|
+          @properties[key] = Chain.new(invocations)
+        end
+      end
+
+      def permit(parent, attributes, subschema=nil)
+        result = parent.permit(attributes)
+        result.tap do |whitelisted|
+          subschema.each do |key, allowed|
+            child = parent[key]
+            next if child.nil?
+            
+            if child.is_a?(Array)
+              whitelisted[key] = child.map { |c| c.permit(allowed) }
+            else
+              whitelisted[key] = child.permit(allowed)
+            end
+          end
+        end
+      end
+
+      def model(mname, &block)
+        @models ||= {}
+        @models[mname] = block
+      end
+
+      def validate(*models)
+        @validations ||= []
+        @validations.concat(models)
+      end
+
+      def transaction(&block)
+        @transactions ||= []
+        @transactions << block
+      end
+
+      def callback
+        @callbacks ||= {}
+        @callbacks.merge!(yield)
+      end
+    end
+
+    attr_reader :props, :params, :errors
+
+    def initialize(params)
+      @params = params
+      @errors = {}
+      @props = {}
+
+      self.class.properties.each do |pname, chain|
+        @props[pname] = chain.apply(params)
+      end
+    end
+
+    def valid?
+      return @errors.empty?
+    end
+
+    def invalid?
+      return !@errors.empty?
+    end
+
+    def extract(*props)
+      props.map { |prop| self.send(prop) }
+    end
+
+    def clean
+      self.reqs(self.props, self.props.keys)
+    end
+
+    def load
+      self.valid? and self.class.models.each do |mname, loader|
+        self.send(:"#{mname}=", Flexcon.dispatch(self, loader))
+      end
+    end
+
+    def validate
+      self.valid? and self.class.validations.each do |mname|
+        self.check(mname => self.send(mname))
+      end if self.class.validations.present?
+
+      self.valid? and self.class.models.each do |mname, loader|
+        self.check(mname => self.send(mname))
+      end if self.class.models.present?
+    end
+
+    def persist
+      self.valid? and UnitOfWork.transaction do |uow|
+        self.class.transactions.each do |handler|
+          handler.call(uow, self)
+        end
+      end
+    end
+    
+    def execute
+      return (
+        self.valid? and
+        self.executed?(:clean) and
+        self.executed?(:load) and 
+        self.executed?(:validate) and
+        self.executed?(:persist)
+      )
+    end
+
+    protected
+      def chain(obj, invocations)
+        return Chain.new(invocations).apply(obj)
+      end
+
+      def reqs(source, attributes)
+        attributes.each do |attribute|
+          next if not source[attribute].blank?
+          @errors[attribute] ||= {}
+          @errors[attribute][:base] = []
+          @errors[attribute][:base] << 'is required'
+        end
+      end
+
+      def executed?(stepname)
+        return (
+          self.callback?(stepname, :before) and
+          self.send(stepname) and
+          self.callback?(stepname, :after)
+        )
+      end
+
+      def callback?(mname, stage)
+        return true if self.class.callbacks.blank?
+        return true if self.class.callbacks[mname].blank?
+
+        Flexcon.dispatch(self, self.class.callbacks[mname][stage])
+      end
+
+      def check(schema)
+        schema.each do |key, model|
+          if model.respond_to?(:each_with_index)
+            self.check_many(key, model)
+          else
+            self.check_one(key, model)
+          end
+        end
+      end
+
+      def check_one(key, model)
+        if model.invalid?
+          @errors[key] ||= {}
+          @errors[key].merge!(model.errors)
+        end
+      end
+
+      def check_many(key, models)
+        models.each_with_index do |m, i|
+          if m.invalid?
+            @errors[key] ||= {}
+            @errors[key][i] ||= {}
+            @errors[key][i].merge!(m.errors)
+          end
+        end
+      end
+  end
+end

data/lib/legatus/extensions/hash.rb

@@ -0,0 +1,5 @@
+class Hash
+  def permit(*keys)
+    self.slice(keys)
+  end
+end

data/lib/legatus/railtie.rb

@@ -0,0 +1,4 @@
+module Legatus
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/legatus/repository.rb

@@ -0,0 +1,25 @@
+module Legatus
+  module Repository
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def find_and_init(filters, attributes=nil)
+        instance = self.find_by(filters)
+        instance ||= self.new
+
+        attributes ||= filters
+        instance.assign_attributes(attributes) 
+
+        return instance
+      end
+
+      def find_or_init(filters, attributes)
+        instance = self.find_by(filters)
+        return if instance.present?
+
+        instance = self.new
+        instance.assign_attributes(attributes) 
+      end
+    end
+  end
+end

data/lib/legatus/unit_of_work.rb

@@ -0,0 +1,36 @@
+module Legatus
+  class UnitOfWork
+
+    def self.transaction
+      ActiveRecord::Base.connection.transaction do 
+        yield(UnitOfWork.new)
+      end
+    end
+
+    def save(*models)
+      models.all? { |model| model.save }
+    end
+
+    def update(*models)
+      models.all? { |model| model.update }
+    end
+
+    def create(*models)
+      models.all? { |model| model.create }
+    end
+
+    def destroy(*models)
+      models.all? { |model| model.destroy }
+    end
+
+    def persist(*models)
+      models.all? do |model| 
+        if model.marked_for_destruction?
+          model.destroy
+        else
+          model.save
+        end
+      end
+    end
+  end
+end

data/lib/legatus/version.rb

@@ -0,0 +1,3 @@
+module Legatus
+  VERSION = '0.1.0'
+end

data/lib/tasks/legatus_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :legatus do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: legatus
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- rcpedro
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.1
+- !ruby/object:Gem::Dependency
+  name: flexcon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: Declare busness directives for actions in Rails.
+email:
+- rodettecpedro@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/legatus.rb
+- lib/legatus/chain.rb
+- lib/legatus/directive.rb
+- lib/legatus/extensions/hash.rb
+- lib/legatus/railtie.rb
+- lib/legatus/repository.rb
+- lib/legatus/unit_of_work.rb
+- lib/legatus/version.rb
+- lib/tasks/legatus_tasks.rake
+homepage: https://github.com/rcpedro/legatus
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Rails Business Directives
+test_files: []