railjet 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2589b9af1a383b92da0c3aff67d6ac361fc51fcf
+  data.tar.gz: fe64333bca9ae67477de220278f2fb940903ef1b
+SHA512:
+  metadata.gz: f9892bc4c813cf15d1f7d9b313cd06f535901fc1be87c4528e2296916d7a0cb716d1cdd52750175ad0adef42281737b43db49a2791406239dd6caaaef4afbddf
+  data.tar.gz: ba0849ad2d77f54bc19c8dcb6474f161036f2227ab858207a90115fe1590f6ca584e4d5ddf918282a6ad8e317e87f1af6982c6101d3ebbe3d7b7c61e8ed387eb

data/.gitignore

@@ -0,0 +1,44 @@
+*.rbc
+capybara-*.html
+/log
+/tmp
+/db/*.sqlite3
+/db/*.sqlite3-journal
+/public/system
+/coverage/
+/spec/tmp
+**.orig
+rerun.txt
+pickle-email-*.html
+
+# TODO Comment out these rules if you are OK with secrets being uploaded to the repo
+config/initializers/secret_token.rb
+config/secrets.yml
+
+# dotenv
+# TODO Comment out this rule if environment variables can be committed
+.env
+
+## Environment normalization:
+/.bundle
+/vendor/bundle
+
+# these should all be checked in to normalize the environment:
+# Gemfile.lock, .ruby-version, .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# if using bower-rails ignore default bower_components path bower.json files
+/vendor/assets/bower_components
+*.bowerrc
+bower.json
+
+# Ignore pow environment settings
+.powenv
+
+# Ignore Byebug command history file.
+.byebug_history
+
+# we don't need the gems in the repo
+/pkg/*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--require spec_helper
+--format documentation

data/.ruby-gemset

@@ -0,0 +1,2 @@
+railjet
+-global

data/.ruby-version

@@ -0,0 +1 @@
+2.3.3

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in railjet.gemspec
+gemspec
+

data/Gemfile.lock

@@ -0,0 +1,96 @@
+PATH
+  remote: .
+  specs:
+    railjet (1.0.1)
+      activemodel (~> 4.2)
+      activesupport (~> 4.2)
+      validates_timeliness (~> 3.0.15)
+      virtus (~> 1.0.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.2.8)
+      activesupport (= 4.2.8)
+      builder (~> 3.1)
+    activesupport (4.2.8)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      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)
+    builder (3.2.3)
+    coderay (1.1.1)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.2.5)
+    equalizer (0.0.11)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    gemfury (0.6.0)
+      faraday (>= 0.9.0, < 0.10.0.pre)
+      highline (~> 1.6.0)
+      multi_json (~> 1.10)
+      netrc (~> 0.10.0)
+      thor (>= 0.14.0, < 1.0.0.pre)
+    highline (1.6.21)
+    i18n (0.8.1)
+    ice_nine (0.11.2)
+    method_source (0.8.2)
+    minitest (5.10.1)
+    multi_json (1.12.1)
+    multipart-post (2.0.0)
+    netrc (0.10.3)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (11.3.0)
+    rake-version (1.0.0)
+      rake (~> 11.1)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    slop (3.6.0)
+    thor (0.19.1)
+    thread_safe (0.3.6)
+    timeliness (0.3.8)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    validates_timeliness (3.0.15)
+      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.14.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Nedap
+
+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,250 @@
+# 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](https://www.swisspasses.com/railpass/popup/railjet/slideshow/RailJet-Zuerich-St.-Anton-Transfer-Ticket-from-Swisspasses.com.jpg)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'railjet'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install railjet
+
+## Usage
+
+### Repository
+
+Assuming your app has 2 ActiveRecord models and uses 1 Cupido object
+
+```ruby
+class Employee < ActiveRecord::Base
+  has_many :events
+end
+
+class Event < ActiveRecord::Base
+  belongs_to :employee
+end
+```
+
+```ruby
+# app/repositories/registry.rb
+AppRegistry = Railjet::Repository::Registry.new
+
+AppRegistry.register(:employee, EmployeeRepository, record: Employee, cupido: Cupido::Employee)
+AppRegistry.register(:event,    EventRepository,    record: Event)
+```
+
+```ruby
+# app/repositories/employee_repository.rb
+class EmployeeRepository
+  include Railjet::Repository
+  
+  delegate :find_contract, to: :cupido
+  
+  def employees_with_contract(employees = record.find_all)
+    employees.select { |e| find_contract(e).present? }
+  end
+  
+  class ActiveRecordRepository
+    include Railjet::Repository::ActiveRecord    
+  end
+  
+  class CupidoRepository
+    include Railjet::Repository::Cupido
+    
+    def find_contract(employee)
+      cupido.find(employee.external_id).contract_agreement
+    end
+  end
+end
+
+# app/repositories/event_repository.rb
+class EventRepository
+  include Railjet::Repository
+  
+  delegate :employees,         to: :registry
+  delegate :find_for_employee, to: :record
+  
+  def events_for_active_employees
+    employees.employees_with_contract.map do |e|
+      find_for_employee(e)
+    end
+  end
+  
+  class ActiveRecordRepository
+    include Railjet::Repository::ActiveRecordRepository
+    
+    def find_for_employee(employee)
+      record.where(employee_id: employee.id).select(query_columns)
+    end
+  end
+end
+```
+
+### UseCase
+
+```ruby
+class UseCase::EditEvent
+  include Railjet::UseCase
+  
+  # auth module is described below
+  check_ability :can_edit_event?  
+  
+  # policy module is described below
+  check_policy { |event| policy(EventEmployeeHasContract, event) } 
+  
+  context      :current_employee
+  repositories :events
+  
+  def call(id, form)
+    event = events.find_by_id(id)
+    
+    with_requirements_check(event) do
+      event.attributes = form.attributes
+      events.persist(event, as: current_employee)
+    end
+  end
+end
+```
+
+### Auth
+```ruby
+# app/auth/ability.rb
+class Auth::Ability < Railjet::Auth::Ability
+
+  def can_edit_event?(event)
+    activity(Auth::Event::Edit, event).can_be_edited_by?(actor)
+  end
+  
+  def can_take_over_event?(event)
+    activity(Auth::Event::Edit, event).can_be_taken_over_by?(actor)
+  end
+  
+  def can_delete_event?(event)
+    activity(Auth::Event::Delete, event).can_be_deleted_by?(actor)
+  end
+end
+```
+
+```ruby
+# app/auth/event/edit.rb
+class Auth::Event::Edit < Railjet::Auth::Activity
+  def can_be_edited_by?(actor)
+  end
+  
+  def can_be_taken_over_by?(actor)
+  end
+end
+
+# app/auth/event/delete.rb
+class Auth::Event::Delete < Railjet::Auth::Activity
+  def can_be_deleted_by?(actor)
+  end
+end
+```
+
+### Policy
+
+```ruby
+class EventEmployeeHasContract
+  object  :event
+  context :repository
+  
+  validate :employee_has_contract
+  
+  private
+  
+  def employee_has_contract
+    errors.add(:employee, "Inactive Employee") unless repository.employees.find_contract(event.employee)
+  end
+end
+```
+
+### Form
+
+Form is a decorator for request params.
+In normal Rails app params are just strings, and they're coerced inside ActiveRecord model. We definitely don't want that. We want to coerce and validate as soon as possible.
+
+Of course, not validations are possible to perform in Form object. It doesn't have access to the context, so there are no settings, no repository. Do as much as possible here, and put more complex stuff in policies
+
+```ruby
+class EditForm
+  include Railjet::Form
+  
+  attribute :name,        String
+  attribute :date,        Date
+  attribute :employee_id, Integer
+  
+  validates_presence_of :name, :date
+end
+```
+
+### Let's connect everything!
+
+```ruby
+# app/context.rb
+class AppContext < Railjet::Context
+  def initialize(current_employee:, repository:)
+    super
+  end
+end
+```
+
+```ruby
+# app/controller/events_controller.rb
+class EventsController < ApplicationController
+  include Railjet::Util::UseCaseHelper
+  include Railjet::Util::FormHelper
+
+  def edit
+    form  = form(EditForm) # this will raise exception if validation rules are not met
+    event = use_case(UseCase::EditEvent).call(params[:id], form)
+
+    respond_with event
+  end
+  
+  private
+  
+  # we need context that will be injected to domain objects
+  def context
+    AppContext.new(
+      current_employee: current_employee,
+      repository:       repository
+    )
+  end
+  
+  def repository
+    AppRegistry.new(settings: care_provider_settings)
+  end
+  
+  def object_params
+    params[:event]
+  end
+  
+  # This one is not necessary, but if you need to do something with params
+  # before they go into the form, this is the place:
+  def clean_params
+    dirty_params = super # this calls #object_params
+    dirty_params.select { |k,v| v.present? }
+  end
+end
+```
+
+## 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, run rake task to bump the version "rake version:bump:<major,minor,patch>" and then run "rake fury:release" to release it to gemfury
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/nedap/ons-context.
+