rubanok 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b5cdbefb98c951e26be6bfcd8029250f8b314c9b7bb86e5d5d778bc340b4d40
-  data.tar.gz: abd725823622bdf1ff062cc1496dfd121522e6b866ec01ce2bc9ea421a56785e
+  metadata.gz: 76b1edc5c67f7a783dc3db022fee6aba015af2745a877d0b05089ce2c2ca2df7
+  data.tar.gz: d3e055c5453c793e17d0c6efea3b0bd6bcb3c8b16ada1461544b28431058a3a1
 SHA512:
-  metadata.gz: aeec1ebbf07db8ec31046cf1442ffac9e6cae698e979768e8560d189f7ab23bfc13d9ef2979dbd45fd00490a5101e3f3b3900d4ff2425b2112880915e8446ba6
-  data.tar.gz: e66af487b2f7b82626d790bc0746559102de30ec0220e5d12de1ce0f29c79c98ed0bad6744ab90df5c5a931b421d90d1b4b4d082e70d15f714efb49fb56b2418
+  metadata.gz: ab19e7909a899d1831f246164888e76c29c1dfd6f9d3864a801b69fd3caba8cc754402a3e3e11ae6a0185bb87cec76711dadcfd8762e32eb4923cf24d3e16bae
+  data.tar.gz: 91c17c4695b0ccc7ff6ab0b75cace311c61b9ca3edf29a43bbd2c747dbb5995bc6f2af45ca6966117dc45304c8cf1ca2f58401bd7329d966a180d8c2942b24dc

data/.travis.yml

@@ -1,5 +1,6 @@
 sudo: false
 language: ruby
+cache: bundler
 rvm:
   - 2.6.0
 
@@ -15,6 +16,8 @@ matrix:
   include:
     - rvm: ruby-head
       gemfile: gemfiles/railsmaster.gemfile
+    - rvm: 2.6.1
+      gemfile: gemfiles/rails6.gemfile
     - rvm: 2.6.0
       gemfile: gemfiles/rails52.gemfile
     - rvm: 2.5.1

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## master
 
+## 0.1.3 (2019-03-05)
+
+- Fix using `activate_always: true` with `default` matching clause. ([@palkan][])
+
 ## 0.1.1 (2019-01-16)
 
 - Fix RSpec matcher to call original implementation instead of returning `nil`. ([@palkan][])

data/README.md

@@ -4,6 +4,8 @@
 
 Rubanok provides a DSL to build parameters-based data transformers.
 
+📖 Read the introduction post: ["Carve your controllers like Papa Carlo"](https://dev.to/evilmartians/carve-your-controllers-like-papa-carlo-32m6)
+
 The typical usage is to describe all the possible collection manipulation for REST `index` action, e.g. filtering, sorting, searching, pagination, etc..
 
 So, instead of:
@@ -58,11 +60,17 @@ Requirements:
 
 ## Installation
 
-**This gem hasn't been released (and even built) yet.**
+Add to your `Gemfile`:
+
+```ruby
+gem "rubanok"
+```
+
+And run `bundle install`.
 
 ## Usage
 
-The core concept of this library is a _plane_ (or _hand plane_, or "рубанок" in Russian). Plane is responsible for mapping parameters to transformrations.
+The core concept of this library is a _plane_ (or _hand plane_, or "рубанок" in Russian). Plane is responsible for mapping parameters to transformations.
 
 From the example above:
 
@@ -127,13 +135,13 @@ class CourseSessionsPlane < Rubanok::Plane
 end
 ```
 
-**NOTE:** matching only match the exact values; more complex matching could be added in the future.
+**NOTE:** Rubanok only matches exact values; more complex matching could be added in the future.
 
 ### Rule activation
 
 Rubanok _activates_ a rule by checking whether the corresponding keys are present in the params object. All the fields must be present to apply the rule.
 
-Sometimes you might want to make some fields optional (or event all of them). You can use `activate_on` and `activate_always` options for that:
+Some fields may be optional, or perhaps even all of them. You can use `activate_on` and `activate_always` options to mark something as an optional key instead of a required one:
 
 ```ruby
 # Always apply the rule; use default values for keyword args
@@ -147,13 +155,13 @@ match :sort_by, :sort, activate_on: :sort_by do
 end
 ```
 
-By default, Rubanok ignores empty param values (using `#empty?` under the hood) and do not activate the matching rules (i.e. `{ q: "" }` or `{ q: nil }` won't activate the `map :q` rule).
+By default, Rubanok ignores empty param values (using `#empty?` under the hood) and will not run matching rules on those values. For example: `{ q: "" }` and `{ q: nil }` won't activate the `map :q` rule.
 
 You can change this behaviour by setting: `Rubanok.ignore_empty_values = false`.
 
 ### Testing
 
-One of the benefits of having all the modification logic in its own class is the ability to test it in isolation:
+One of the benefits of having modification logic contained in its own class is the ability to test modifications in isolation:
 
 ```ruby
 # For example, with RSpec
@@ -194,10 +202,50 @@ require "rubanok/rspec"
 
 ### Rails vs. non-Rails
 
-Rubanok is a Rails-free library but has some useful Rails extensions, such as `planish` helper for controllers (included automatically into `ActionController::Base` and `ActionController::API`).
+Rubanok does not require Rails, but it has some useful Rails extensions such as `planish` helper for controllers (included automatically into `ActionController::Base` and `ActionController::API`).
 
 If you use `ActionController::Metal` you must include the `Rubanok::Controller` module yourself.
 
+## Questions & Answers
+
+- **🧐"Planish"? Is there a word?**
+
+Yes, [it is](https://en.wiktionary.org/wiki/planish).
+
+- **Where to put my _plane_ classes?**
+
+I put mine under `app/planes` (as `<resources>_plane.rb`) in my Rails app.
+
+- **I don't like the naming ("planes" ✈️?), can I still use the library?**
+
+First, feel free to [propose your variant](https://github.com/palkan/rubanok/issues). We would be glad to discuss it.
+
+Secondly, you can easily avoid it by adding a few lines to your `ApplicationController`:
+
+```ruby
+class ApplicationController < ActionController::Smth
+  # add `planish` alias
+  alias transform_scope planish
+
+  # override the `implicit_plane_class` method
+  def implicit_plane_class
+    "#{controller_path.classify.pluralize}Scoper".safe_constantize
+  end
+end
+```
+
+Now you can use it like this:
+
+```ruby
+class CourseSessionsController < ApplicationController
+  def index
+    @sessions = transform_scope(CourseSession.all, params)
+    # which equals to
+    @sessions = CourseSessionsScoper.call(CourseSession.all, params.to_unsafe_h)
+  end
+end
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/palkan/rubanok.

data/gemfiles/rails6.gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gem "actionpack", "6.0.0.beta1"
+gem "actionview", "6.0.0.beta1"
+
+gemspec path: ".."

data/lib/rubanok/dsl/matching.rb

@@ -69,7 +69,7 @@ module Rubanok
 
         rule.instance_eval(&block)
 
-        define_method(rule.to_method_name) do |params|
+        define_method(rule.to_method_name) do |params = {}|
           clause = rule.matching_clause(params)
           next raw unless clause
 

data/lib/rubanok/railtie.rb

@@ -8,6 +8,12 @@ module Rubanok # :nodoc:
 
         ActionController::Base.include Rubanok::Controller
       end
+
+      ActiveSupport.on_load(:action_controller_api) do
+        require "rubanok/rails/controller"
+
+        ActionController::API.include Rubanok::Controller
+      end
     end
   end
 end

data/lib/rubanok/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rubanok
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
 end

data/rubanok.gemspec

@@ -31,5 +31,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rspec-rails"
   spec.add_development_dependency "rubocop-rspec"
-  spec.add_development_dependency "standard"
+  spec.add_development_dependency "standard", "~> 0.0.36"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubanok
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-17 00:00:00.000000000 Z
+date: 2019-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -112,16 +112,16 @@ dependencies:
   name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.36
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.36
 description: Parameters-based transformation DSL
 email:
 - dementiev.vm@gmail.com
@@ -143,6 +143,7 @@ files:
 - bin/setup
 - gemfiles/rails42.gemfile
 - gemfiles/rails52.gemfile
+- gemfiles/rails6.gemfile
 - gemfiles/railsmaster.gemfile
 - lib/rubanok.rb
 - lib/rubanok/dsl/mapping.rb
@@ -174,8 +175,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: Parameters-based transformation DSL