railjet 2.1.1 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d092976ecd3a3258ec44edd6c62e1ba88f969444
-  data.tar.gz: '08158874d5f23f745fb6c98e19e2a2a3e9f4431e'
+SHA256:
+  metadata.gz: b6d6d6acf675dc2748a34616f8b557b249a3d2e0357691daf10e4392f32ff293
+  data.tar.gz: e8fc6a55ffe4a4b23ea98e005aa6af14ec7221cf89a719f71db1a7d7783cbfb6
 SHA512:
-  metadata.gz: 3f7fbda03ee87bad58bd72dd033e400a46c6d5b9ef77f6d358aa801d1364ea2a5899a2247f3efb87e7f7227ccaec52a34fd39b604be2e5be3e1b25610a19cd1f
-  data.tar.gz: 8037cc8eeab89a9c69c84e59a2b47629d04dd1870f44830a8252a9d554333e18d3f14d43b1b4efbd686a8534e76a98b982fb1aed41a130972a1d1c3455ed88e6
+  metadata.gz: d34e90c6aaef996d172c09c45226d9872593623f04ec83b82defd0fa92b14cc5287496dc069f6ffc2c53a5b021f638185285fa39ddcb87840756bf20d04ea3cf
+  data.tar.gz: ddc2eee2f9c1835ea48eb138655bf8ff9ad79bfa2a7a6cd95723ec56554cb7fe3ebdb472608afb8c6d2c070fc190507376d1a02770cb66e8b2b353647745bde3

data/.github/workflows/test.yml

@@ -0,0 +1,19 @@
+name: Test
+
+on: [push]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+
+      - name: Run tests
+        run: bundle exec rspec spec

data/.gitignore

@@ -1,3 +1,4 @@
+Gemfile.lock
 *.rbc
 capybara-*.html
 /log

data/.ruby-version

@@ -1 +1 @@
-2.3.3
+2.6.6

data/README.md

@@ -1,7 +1,18 @@
-# Railjet, architecture for high-speed railway   [![Build Status](https://travis-ci.com/nedap/railjet.svg?token=sx7KNHQkbW5qxVMs4wKk&branch=master)](https://travis-ci.com/nedap/railjet)
+# Railjet, architecture for high-speed railway
+
+[![Maintainability](https://api.codeclimate.com/v1/badges/457bb41a82546fd6e459/maintainability)](https://codeclimate.com/github/nedap/railjet/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/457bb41a82546fd6e459/test_coverage)](https://codeclimate.com/github/nedap/railjet/test_coverage)
 
 ![Railjet](https://www.swisspasses.com/railpass/popup/railjet/slideshow/RailJet-Zuerich-St.-Anton-Transfer-Ticket-from-Swisspasses.com.jpg)
 
+## Philosophy
+
+We all know how good it feels to start a greenfield project in Rails. At that point Rails Way makes you move amazingly fast - you just create your models, include some gems in Gemfile and boom, your prototype is almost there. This is what almost every tutorial or a book will show you. But what's going to happen when your app is not generic small-to-mid-size-app? What if you have to start breaking those Rails conventions that made you fall in love with Rails in the first place? That could be because of using multiple data storages, working with legacy URLs or DB schemas, having tons of domain logic that is making your ActiveModel so fat that no diet can help. We all know DHH's answer to that - Concerns. And yeah, they're cool for extracting shared behaviour out of models, but that's it.
+
+Seems like Rails does not have a good answer. But what if someone else already had it? People are writing complex software for decades now, they had to come up with some ideas how to keep them clean, simple and maintainable.
+
+See our [wiki](https://github.com/nedap/railjet/wiki) for more extended information on railjet why and how 
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -18,7 +29,7 @@ Or install it yourself as:
 
     $ gem install railjet
 
-## Usage
+## Example Usage
 
 ### Repository
 
@@ -242,7 +253,7 @@ end
 
 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, run rake task to bump the version "rake version:bump:<major,minor,patch>" and then run "rake fury:release" to release it to gemfury
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, run rake task to bump the version `rake version:bump:<major,minor,patch>` and then run `rake release` to release it to https://rubygems.org/
 
 ## Contributing
 

data/VERSION

@@ -1 +1 @@
-2.1.1
+3.3.0

data/lib/active_model/merge_errors.rb

@@ -1,22 +1,6 @@
 ActiveModel::Errors.class_eval do
   def <<(other)
-    copy_messages_from(other)
-    copy_details_from(other) if respond_to?(:details)
-
+    self.merge!(other)
     self
   end
-
-  private
-
-  def copy_details_from(other)
-    details.merge!(other.details) do |_, val_one, val_two|
-      [*val_one] + [*val_two]
-    end
-  end
-
-  def copy_messages_from(other)
-    messages.merge!(other.messages) do |_, val_one, val_two|
-      [*val_one] + [*val_two]
-    end
-  end
 end

data/lib/railjet.rb

@@ -44,8 +44,17 @@ require "railjet/policy"
 require "railjet/composed_policy"
 require "railjet/use_case"
 require "railjet/presenter"
+require "railjet/presenter_context"
 
 require "railjet/repository/registry"
 require "railjet/repository"
 require "railjet/repository/active_record"
 require "railjet/repository/redis"
+
+if defined?(Rails)
+  Rails::Application.console do
+    require "railjet/console/debug_helpers"
+
+    Railjet::Console::RailjetHelpers.load
+  end
+end

data/lib/railjet/console/debug_helpers.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+module Railjet
+  module Console
+    # Adds helper methods for auditing of console customer usage
+    module RailjetHelpers
+      def setup_railjet(context_class: nil)
+        @context_class = context_class
+
+        @context_class ||= RailjetContextHelper.determine_context_class
+
+        railjet_helper_after_init_message
+      end
+
+      def railjet_helper_after_init_message
+        puts 'Setup finished. railjet helpers are now available from console'
+        puts 'available commands:'
+        puts "\t- use_case(<Class>)"
+        puts "\t- form(<Class>, params)"
+        puts "\t- console_context"
+      end
+
+      def railjet_helper_after_load_message
+        puts '*' * 61
+        puts "\nCall 'setup_railjet' to setup and debug Railjet"
+        puts 'Argument are:'
+        method(:setup_railjet).parameters.each do |param|
+          case param[0]
+          when :key, :keyreq
+            puts "\t- #{param[1]}:"
+          else
+            puts "\t- #{param[1]}"
+          end
+        end
+        puts "\n"
+        puts '*' * 61
+      end
+
+      def console_context
+        @context_class.init(
+          *context_params
+        )
+      end
+
+      def use_case(klass)
+        klass.new(console_context)
+      end
+
+      def form(klass, clean_params)
+        klass.new(clean_params).tap(&:validate)
+      end
+
+      def context_params
+        parameters, missing_methods = find_context_params
+
+        RailjetContextHelper.print_context_param_errors(missing_methods)
+
+        parameters
+      end
+
+      def find_context_params
+        parameters = []
+        missing_methods = []
+
+        @context_class.method(:init).parameters.each do |param|
+          param_value, missing_method_error = find_context_param(
+            param[0], param[1]
+          )
+
+          parameters.push(param_value)
+
+          if missing_method_error.present?
+            missing_methods.push(missing_method_error)
+          end
+        end
+
+        [parameters, missing_methods]
+      end
+
+      def find_context_param(type, method_name)
+        send("find_#{type}_context_param", method_name)
+      end
+
+      def find_req_context_param(method_name)
+        [send(method_name), nil]
+      rescue StandardError => e
+        [nil, { method_name => e.message }]
+      end
+      alias find_opt_context_param find_req_context_param
+
+      def find_keyreq_context_param(method_name)
+        [{ method_name => send(method_name) }, nil]
+      rescue StandardError => e
+        [{ method_name => nil }, { method_name => e.message }]
+      end
+      alias find_key_context_param find_keyreq_context_param
+
+      def self.load
+        Object.include(self)
+      end
+
+      class RailjetContextHelper
+        def self.determine_context_class
+          contexts_classes = Railjet::Context.descendants
+          contexts_classes.each_with_index do |context_class, index|
+            puts "(#{index + 1}) #{context_class}"
+          end
+
+          puts "\nPlease enter the number of needed railjet context"
+          puts "(default: #{contexts_classes.first})"
+          puts '-' * 61
+
+          begin
+            input = $stdin.gets.strip
+            if input.present?
+              chosen_index = Float(input)
+              contexts_classes.fetch(chosen_index - 1)
+            else
+              contexts_classes[0]
+            end
+          rescue StandardError
+            puts 'Invalid choice. Please try again.'
+            retry
+          end
+        end
+
+        def self.print_context_param_errors(missing_methods)
+          return if missing_methods.empty?
+
+          puts '!' * 61
+          puts "\nError raised while finding context value(s) for methods below using `nil` instead"
+          puts "To assign value simply define function(s) in console and it will be used the next time\n\n"
+          missing_methods.each do |error|
+            puts "\t- Method `#{error.keys.first}` => error: `#{error.values.first}`"
+          end
+          puts "\n"
+          puts '!' * 61
+        end
+      end
+    end
+  end
+end
+

data/lib/railjet/presenter.rb

@@ -8,25 +8,29 @@ module Railjet
       @object = object
     end
 
+    attr_reader :object
+
     def as_json(*)
       raise NotImplementedError
     end
 
     module ClassMethods
       def present_collection(objects)
-        objects.map { |o| new(o) }
+        objects.map { |o| present(o) }
       end
 
-      private
+      def present(object)
+        new(object)
+      end
 
-      def present(name)
-        define_method(name) { instance_variable_get(:@object) }
-        private name
+      def object(name)
+        alias_method name, :object
       end
     end
 
     module WithContext
       extend ActiveSupport::Concern
+      include Railjet::Presenter
 
       included do
         attr_reader :context
@@ -40,7 +44,15 @@ module Railjet
 
       module ClassMethods
         def present_collection(context, objects)
-          objects.map { |o| new(context, o) }
+          objects.map { |o| present(context, o) }
+        end
+
+        def present(context, object)
+          new(context, object)
+        end
+
+        def context(*context_members)
+          delegate *context_members, to: :context
         end
       end
 

data/lib/railjet/presenter_context.rb

@@ -0,0 +1,14 @@
+module Railjet
+  class PresenterContext < SimpleDelegator
+    attr_reader :view
+
+    def initialize(context, view_context)
+      super(context)
+      @view = view_context
+    end
+
+    def repository
+      raise NoMethodError, "Acessing Repository from Presenter is a no-no 🙅‍♂️"
+    end
+  end
+end

data/lib/railjet/repository/active_record.rb

@@ -10,6 +10,10 @@ module Railjet
           record.all
         end
 
+        def find_by_id(id)
+          record.find(id)
+        end
+
         def find_by_ids(ids)
           record.where(id: ids)
         end

data/lib/railjet/version.rb

@@ -1,3 +1,3 @@
 module Railjet
-  VERSION = "2.1.1"
+  VERSION = "3.3.0"
 end

data/railjet.gemspec

@@ -19,15 +19,15 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler",              "~> 1.11"
-  spec.add_development_dependency "rake",                 "~> 11.0"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake",                 "> 13"
   spec.add_development_dependency "rspec",                "~> 3.0"
   spec.add_development_dependency "pry"
-  spec.add_development_dependency "gemfury"
   spec.add_development_dependency "rake-version",         "~> 1.0"
+  spec.add_development_dependency "simplecov",            "~> 0.17.1"
 
-  spec.add_dependency             "activesupport",        '> 4'
-  spec.add_dependency             "activemodel",          '> 4'
+  spec.add_dependency             "activesupport",        '> 5.2'
+  spec.add_dependency             "activemodel",          '> 5.2'
   spec.add_dependency             "virtus",               "~> 1.0.2"
-  spec.add_dependency             "validates_timeliness", "~> 4.0.2"
+  spec.add_dependency             "validates_timeliness", "~> 4.1"
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: railjet
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 3.3.0
 platform: ruby
 authors:
 - Krzysztof Zalewski
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-04-11 00:00:00.000000000 Z
+date: 2021-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: '13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: '13'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -67,61 +67,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: gemfury
+  name: rake-version
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: rake-version
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 0.17.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 0.17.1
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: virtus
   requirement: !ruby/object:Gem::Requirement
@@ -142,14 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.2
+        version: '4.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.2
+        version: '4.1'
 description: Design patterns for Ruby on Rails
 email:
 - zlw.zalewski@gmail.com
@@ -157,13 +157,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
 - ".ruby-gemset"
 - ".ruby-version"
-- ".travis.yml"
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -182,10 +181,12 @@ files:
 - lib/railjet/auth/ability.rb
 - lib/railjet/auth/activity.rb
 - lib/railjet/composed_policy.rb
+- lib/railjet/console/debug_helpers.rb
 - lib/railjet/context.rb
 - lib/railjet/form.rb
 - lib/railjet/policy.rb
 - lib/railjet/presenter.rb
+- lib/railjet/presenter_context.rb
 - lib/railjet/repository.rb
 - lib/railjet/repository/active_record.rb
 - lib/railjet/repository/generic.rb
@@ -202,7 +203,7 @@ homepage: https://github.com/nedap/railjet
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -217,9 +218,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Better architecture for high-speed railway
 test_files: []

data/.travis.yml

@@ -1,2 +0,0 @@
----
-language: ruby

data/Gemfile.lock

@@ -1,94 +0,0 @@
-PATH
-  remote: .
-  specs:
-    railjet (2.1.1)
-      activemodel (> 4)
-      activesupport (> 4)
-      validates_timeliness (~> 4.0.2)
-      virtus (~> 1.0.2)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activemodel (5.2.3)
-      activesupport (= 5.2.3)
-    activesupport (5.2.3)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    axiom-types (0.1.1)
-      descendants_tracker (~> 0.0.4)
-      ice_nine (~> 0.11.0)
-      thread_safe (~> 0.3, >= 0.3.1)
-    coderay (1.1.2)
-    coercible (1.0.0)
-      descendants_tracker (~> 0.0.1)
-    concurrent-ruby (1.1.5)
-    descendants_tracker (0.0.4)
-      thread_safe (~> 0.3, >= 0.3.1)
-    diff-lcs (1.3)
-    equalizer (0.0.11)
-    faraday (0.11.0)
-      multipart-post (>= 1.2, < 3)
-    gemfury (0.7.0)
-      faraday (>= 0.9.0, < 0.12.0.pre)
-      highline (~> 1.6)
-      multi_json (~> 1.10)
-      netrc (>= 0.10.0, < 0.12.0.pre)
-      thor (>= 0.14.0, < 1.0.0.pre)
-    highline (1.7.8)
-    i18n (1.6.0)
-      concurrent-ruby (~> 1.0)
-    ice_nine (0.11.2)
-    method_source (0.9.0)
-    minitest (5.11.3)
-    multi_json (1.12.2)
-    multipart-post (2.0.0)
-    netrc (0.11.0)
-    pry (0.11.1)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    rake (11.3.0)
-    rake-version (1.0.0)
-      rake (~> 11.1)
-    rspec (3.6.0)
-      rspec-core (~> 3.6.0)
-      rspec-expectations (~> 3.6.0)
-      rspec-mocks (~> 3.6.0)
-    rspec-core (3.6.0)
-      rspec-support (~> 3.6.0)
-    rspec-expectations (3.6.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.6.0)
-    rspec-mocks (3.6.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.6.0)
-    rspec-support (3.6.0)
-    thor (0.20.0)
-    thread_safe (0.3.6)
-    timeliness (0.3.10)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
-    validates_timeliness (4.0.2)
-      timeliness (~> 0.3.7)
-    virtus (1.0.5)
-      axiom-types (~> 0.1)
-      coercible (~> 1.0)
-      descendants_tracker (~> 0.0, >= 0.0.3)
-      equalizer (~> 0.0, >= 0.0.9)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.11)
-  gemfury
-  pry
-  railjet!
-  rake (~> 11.0)
-  rake-version (~> 1.0)
-  rspec (~> 3.0)
-
-BUNDLED WITH
-   1.17.3