railjet 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7fd0eeccd892fe25d1d16c29b32005c450cc2fb8a4117eedb3285841a0b17fc9
-  data.tar.gz: d49747d24cb15b3a18a4cec177e8d5bef8356fbbd29031586359552368d3178c
+  metadata.gz: dabef786fc068425030ba7491d155b468603cad7e60b87cba1279947675193bb
+  data.tar.gz: e3bec2083b8df544538483cd4c31bb7450926075f9b214f70bf9797be52693d3
 SHA512:
-  metadata.gz: 3c5edeaee7236db8b358f02b8c8e5173913b3fef0abcc01f4d8c1bb54d7c0d808cdc0d06c202fb778b8d65c2f52f3f1bc7db7c67d75ec069db5c599ec433c257
-  data.tar.gz: 6d989eeb3f1d36564a6ad5f9253224729c3f013fdd41857a6c4a5f860b742408e9f6e4b60aa72b7a4184b36c13a60748b9964fc3f87e6d0381929c644b6abb0f
+  metadata.gz: c86ac300b35515fa2474f2f0da707ee42df17b98b586dcd74dd926c2459a3e2e6bf2d56412a88427bc82fcab0b60dde9cc190607e769ee771dffe825a71e1a3c
+  data.tar.gz: 74dd2b89e62fc17ae6ae1f54358cea04156cbe446bbdec1bf738b04d6125f5394975b41204498ea55bd1aae7b3b8e2cfdd3143c7db6c47780b1483b60a0f02da

data/.semaphore/semaphore.yml

@@ -1,5 +1,5 @@
 version: v1.0
-name: Initial Pipeline
+name: Railjet Pipeline
 agent:
   machine:
     type: e1-standard-2
@@ -8,8 +8,11 @@ auto_cancel:
   running:
     when: "branch != 'master'"
 blocks:
-  - name: 'Block #1'
+  - name: 'Rspec'
     task:
+      env_vars:
+        - name: CC_TEST_REPORTER_ID
+          value: 9cfd93bf8178ecfe837889113add5d001b2110503d238294a56ac7dcb3286852
       jobs:
         - name: specs
           matrix:
@@ -18,7 +21,10 @@ blocks:
           commands:
             - sem-version ruby $RUBY_VERSION
             - bundle install --path vendor/bundle
+            - source ./.semaphore/setup_codeclimate_test_coverage.sh
             - bundle exec rake spec
+            - ./cc-test-reporter format-coverage
+            - ./cc-test-reporter upload-coverage
       prologue:
         commands:
           - checkout

data/.semaphore/setup_codeclimate_test_coverage.sh

@@ -0,0 +1,11 @@
+cache restore cc-test-reporter-$(date +%F)
+
+if [ -f 'cc-test-reporter' ]; then
+  echo 'found test reporter in cache'
+else
+  curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  chmod +x ./cc-test-reporter
+  cache store cc-test-reporter-$(date +%F) cc-test-reporter
+fi
+
+./cc-test-reporter before-build

data/README.md

@@ -1,5 +1,8 @@
-# Railjet, architecture for high-speed railway   [![Build Status](https://nedap-opensource.semaphoreci.com/badges/railjet/branches/master.svg?style=shields)](https://semaphoreci.com/nedap/railjet)
+# Railjet, architecture for high-speed railway
 
+[![Build Status](https://nedap-opensource.semaphoreci.com/badges/railjet/branches/master.svg?style=shields)](https://semaphoreci.com/nedap/railjet) 
+[![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)
 
@@ -251,7 +254,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 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 @@
-3.1.0
+3.2.0

data/lib/railjet.rb

@@ -50,3 +50,11 @@ 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/version.rb

@@ -1,3 +1,3 @@
 module Railjet
-  VERSION = "3.1.0"
+  VERSION = "3.2.0"
 end

data/railjet.gemspec

@@ -23,8 +23,8 @@ Gem::Specification.new do |spec|
   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'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: railjet
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Krzysztof Zalewski
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-07 00:00:00.000000000 Z
+date: 2020-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -67,33 +67,33 @@ 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
@@ -162,6 +162,7 @@ files:
 - ".ruby-gemset"
 - ".ruby-version"
 - ".semaphore/semaphore.yml"
+- ".semaphore/setup_codeclimate_test_coverage.sh"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -181,6 +182,7 @@ 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