readymade 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 544c5ded752ee719d0f562e17a0c0ce58c78e6fa1da485b1b4e8c19d0dc88e21
+  data.tar.gz: e23c2ac26779987b73cfe45483ca0b856ff690b687fca08ef48ff917fbf51739
+SHA512:
+  metadata.gz: 4a82c9c992c58031a679488fffe58203703f07ba2b63036322cc7d97a704dc954b58efea3fb5c1a29ae27fcbf82871f409721a533e1558edc0b0a92dce57102c
+  data.tar.gz: 7b8dab1d0db59d93757d4eb00cc78d4514cf00692386394658a328647c5f4a8f720f71f8f8a8e9aa26d05fb8f7430b90d9fc4b1f6fdb1e5f7a82c64427e74003

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.2
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at orest.f@coaxsoft.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in lead.gemspec
+gemspec
+
+gem 'activemodel'

data/Gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: .
+  specs:
+    readymade (0.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.1.4.1)
+      activesupport (= 6.1.4.1)
+    activesupport (6.1.4.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    byebug (11.1.3)
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.4.4)
+    i18n (1.8.11)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.4)
+    rake (13.0.6)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.5.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activemodel
+  byebug
+  rake
+  readymade!
+  rspec
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 OrestF
+
+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,44 @@
+# Lead
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/readymade`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'readymade'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install readymade
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/readymade. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/readymade/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Lead project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/readymade/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'readymade'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/readymade/action.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'readymade/response'
+
+module Readymade
+  class Action
+    class NonKeywordArgumentsError < StandardError; end
+
+    def self.call(*args, &block)
+      new(*args, &block).call
+    end
+
+    attr_reader :args, :data
+
+    def initialize(**args)
+      raise NonKeywordArgumentsError if args.present? && !args.is_a?(Hash)
+
+      @args = @data = args
+
+      @args.each do |name, value|
+        instance_variable_set("@#{name}", value)
+      end
+
+      # yield if block_given?
+    end
+
+    def call; end
+
+    def response(status, *args)
+      Response.new(status, *args)
+    end
+  end
+end

data/lib/readymade/form.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+require 'active_model'
+
+module Readymade
+  class Form
+    include ActiveModel::Model
+
+    attr_accessor :record, :params, :args
+
+    PERMITTED_ATTRIBUTES = [].freeze
+    REQUIRED_ATTRIBUTES = [].freeze
+
+    def initialize(params, **args)
+      @params = params
+      @record = args[:record]
+      @args = args
+      @nested_forms = []
+      @required_attributes = Array(args[:required]).presence
+      @permitted_attributes = (Array(@required_attributes) + Array(args[:permitted])).presence
+
+      parse_datetime_params
+
+      # Slice all attributes which is not required by form
+      # to omit save of unpredictable params
+      @params&.slice!(*permitted_attributes) # if permitted_attributes.present?
+
+      # dynamically creates attr accessors
+      @params&.keys&.each do |key|
+        singleton_class.class_eval do
+          attr_accessor key
+        end
+      end
+      # automatically validates all REQUIRED_ATTRIBUTES
+      singleton_class.validates(*required_attributes, presence: true) if required_attributes.present?
+
+      build_nested_forms
+
+      super(@params)
+    end
+
+    def permitted_attributes
+      @permitted_attributes ||= self.class::PERMITTED_ATTRIBUTES
+    end
+
+    def required_attributes
+      @required_attributes ||= self.class::REQUIRED_ATTRIBUTES
+    end
+
+    def build_nested_forms
+      nested_forms_mapping.each do |attr, form_class|
+        next if params[attr].blank?
+
+        if form_class.is_a?(Array)
+          n_forms = params[attr].map { |_i, attrs| form_class[0].new(attrs) }
+
+          @nested_forms.push(*n_forms)
+          define_singleton_method("#{attr}_forms") { n_forms }
+        else
+          @nested_forms.push(f = form_class.new(params[attr]))
+          define_singleton_method("#{attr}_form") { f }
+        end
+      end
+    end
+
+    def validate
+      super && validate_nested(*nested_forms)
+    end
+
+    def validate_nested(*nested_forms)
+      nested_forms.compact.map(&:validate).all? || sync_nested_errors(nested_forms)
+    end
+
+    def sync_nested_errors(nested_forms)
+      nested_forms.each do |n_form|
+        n_form.errors.each do |code, text|
+          errors.add("#{n_form.humanized_name}.#{code}", text)
+        end
+      end
+
+      false
+    end
+
+    def sync_errors(from: self, to: record)
+      return if [from, to].any?(&:blank?)
+
+      errors = from.errors.instance_variable_get('@messages')
+      errors.merge!(to.errors.instance_variable_get('@messages'))
+
+      to.errors.instance_variable_set('@messages', errors)
+      to.errors.messages.transform_values!(&:uniq)
+    end
+
+    def humanized_name
+      self.class.name.underscore.split('/')[0]
+    end
+
+    # uses datetime_params to fix the following issue:
+    # https://stackoverflow.com/questions/5073756/where-is-the-rails-method-that-converts-data-from-datetime-select-into-a-datet
+    def parse_datetime_params
+      datetime_params.each do |param|
+        next if @params[param].present?
+
+        # set datetime to nil if year is blank
+        if @params["#{param}(1i)"].blank?
+          @params[param] = nil
+
+          next
+        end
+
+        @params[param] = DateTime.new(*(1..5).map { |i| @params["#{param}(#{i}i)"].to_i })
+      end
+    rescue ArgumentError
+      nil
+    end
+
+    # list datetime_params in child form in order to parse datetime properly
+    def datetime_params
+      []
+    end
+
+    # list nested_forms in child form in order to validate them
+    attr_reader :nested_forms
+
+    # define nested forms in format { attr_name: MyFormClass }
+    # use the following syntax if attribute is a collection: { attr_collection_name: [MyFormClass] }
+    def nested_forms_mapping
+      {}
+    end
+  end
+end

data/lib/readymade/operation.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require 'readymade/response'
+require 'readymade/action'
+
+module Readymade
+  class Operation < Readymade::Action
+    attr_reader :form, :record, :record_params
+
+    private
+
+    def build_form
+      @form = form_class.new(record_params, record: record)
+    end
+
+    def form_valid?
+      form.validate
+    end
+
+    def assign_attributes
+      record.assign_attributes(record_params)
+    end
+
+    def record_valid?
+      return true if record.errors.none? && record.valid?
+
+      sync_errors_to_form && false
+    end
+
+    def save_record
+      record.save
+    end
+
+    def response(status, *args)
+      Response.new(status, *args)
+    end
+
+    def success(*args)
+      response(:success, *args)
+    end
+
+    def validation_fail(status = :validation_fail, args = {})
+      sync_errors_to_form
+      response(status, args.merge!(record: record,
+                                   record_params: record_params,
+                                   form: form,
+                                   errors: form.errors.messages))
+    end
+
+    def fail(status = :fail, args = {})
+      sync_errors_to_form
+
+      response(status, args.merge!(record: record,
+                                   record_params: record_params,
+                                   form: form,
+                                   errors: form&.errors&.messages.presence || record&.errors&.messages))
+    end
+
+    def form_class
+      raise 'Define your own form object class in your operation'
+    end
+
+    def sync_errors_to_form
+      form.sync_errors(from: record, to: form)
+    end
+
+    def sync_errors_to_record
+      form.sync_errors
+    end
+  end
+end

data/lib/readymade/response.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Readymade
+  class Response
+    class NonKeywordArgumentsError < StandardError; end
+
+    DEFAULT_STATUSES = %i[success fail].freeze
+
+    DEFAULT_STATUSES.each do |ds|
+      define_method("#{ds}?") do
+        ds.to_s == status
+      end
+    end
+
+    attr_reader :status, :args, :data
+
+    def initialize(status, *args)
+      @status = status.to_s
+
+      raise NonKeywordArgumentsError if args.present? && !args[0].is_a?(Hash)
+
+      @args = @data = args[0]
+
+      define_singleton_method("#{status}?") do
+        true
+      end
+    end
+
+    def errors
+      args[:errors].presence || {}
+    end
+
+    def method_missing(method_name, *args, &block)
+      return false if method_name.to_s.end_with?('?')
+
+      super
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      method_name.to_s.end_with?('?') || super
+    end
+  end
+end

data/lib/readymade/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Readymade
+  VERSION = '0.1.0'
+end

data/lib/readymade.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'readymade/action'
+require 'readymade/form'
+require 'readymade/operation'
+require 'readymade/response'
+require 'readymade/version'
+
+module Readymade
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/readymade.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative 'lib/readymade/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'readymade'
+  spec.version       = Readymade::VERSION
+  spec.authors       = ['OrestF']
+  spec.email         = ['falchuko@gmail.com']
+
+  spec.summary       = 'Set of base classes for ABDI architecture'
+  spec.description   = 'Set of base classes for ABDI architecture'
+  spec.homepage      = 'https://github.com/OrestF/readymade'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  # spec.metadata['allowed_push_host'] = 'rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = "#{spec.homepage}/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: readymade
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- OrestF
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-11-03 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: Set of base classes for ABDI architecture
+email:
+- falchuko@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/readymade.rb
+- lib/readymade/action.rb
+- lib/readymade/form.rb
+- lib/readymade/operation.rb
+- lib/readymade/response.rb
+- lib/readymade/version.rb
+- readymade.gemspec
+homepage: https://github.com/OrestF/readymade
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/OrestF/readymade
+  source_code_uri: https://github.com/OrestF/readymade
+  changelog_uri: https://github.com/OrestF/readymade/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Set of base classes for ABDI architecture
+test_files: []