tram-policy 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7444c114cfc1974d6a3879cbcde499e7a2e5c93d
-  data.tar.gz: 70cc15eee36c5a8d119651e417b35af6d7d2f37d
+  metadata.gz: d61d4df530a82fdee0fffa4c5129421348d60c18
+  data.tar.gz: e129c65a0019df533cad7e2b90981c332572a6be
 SHA512:
-  metadata.gz: b106e053fba00768a53c69622603477cd02ac022b0d67c0a8a15c6b7300216778ebbbb328b37e5d974f6b76e89044a1814e9e5428334e8ff93594a1eb01d4260
-  data.tar.gz: 62c9b7a44a394c02be30fd2fcb4153b595dbca4d80d941f55b8944c3520ec392e247cf1a57af1dfec58b47e50d0bc865f44f7d59298f8b982da3ad4c9353f53d
+  metadata.gz: 3e11195f58b75868feaacb300a57377dbb5ba1d5955709c6ee589d8729bc7304a685cfe2db9c48f6e0f1a7ffb47c0746def0c9331c262199853662cdf8b6624e
+  data.tar.gz: f3d07ca8653f883a72052abc0c3430845ad4c1d88177a8f266ca02f0c73a4b0e31e367cd658955ea6a129d0668b1d22695bd249926780080a9b7d3bba1caba95

data/CHANGELOG.md

@@ -6,8 +6,28 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [0.0.2] - [2017-04-25]
+The gem is battle-tested for production (in a real commertial project).
+
+### Removed
+- `.validate` with several keys for several validators at once (@nepalez)
+
+  Use a multiline version instead of `validate :foo, :bar`:
+
+  ```
+  validate :foo
+  validate :bar
+  ```
+
+### Added
+- `.validate` supports option `stop_on_failure` (@nepalez)
+
+### Fixed
+- Minor bugs in generators (@nepalez)
+
 ## [0.0.1] - [2017-04-18]
 This is a first public release (@nepalez, @charlie-wasp, @JewelSam, @sergey-chechaev)
 
 [Unreleased]: https://github.com/tram-rb/tram-policy
 [0.0.1]: https://github.com/tram-rb/tram-policy/releases/tag/v0.0.1
+[0.0.2]: https://github.com/tram-rb/tram-policy/compare/v0.0.1...v0.0.2

data/README.md

@@ -172,6 +172,36 @@ rescue Tram::Policy::ValidationError => error
 end
 ```
 
+## Additional options
+
+Class method `.validate` supports several options:
+
+### `stop_on_faiure`
+
+If a selected validation will fail (adds an error to the collection), the following validations won't be executed.
+
+```ruby
+require "tram-policy"
+
+class Article::ReadinessPolicy < Tram::Policy
+  # required param for article to validate
+  param  :article
+
+  validate :title_presence, stop_on_failure: true
+  validate :title_valid # not executed if title is absent
+
+  # ...
+end
+```
+
+### `if`
+
+[WIP] Not implemented (coming soon in v0.1.0)
+
+### `unless`
+
+[WIP] Not implemented (coming soon in v0.1.0)
+
 ## RSpec matchers
 
 RSpec matchers defined in a file `tram-policy/matcher` (not loaded in runtime).
@@ -197,7 +227,7 @@ end
 
 ```ruby
 # spec/spec_helper.rb
-require "tram-policy/matcher"
+require "tram/policy/rspec"
 ```
 
 ```ruby
@@ -217,14 +247,14 @@ RSpec.describe User::ReadinessPolicy do
 end
 ```
 
-**Notice** that you have to wrap policy into block `{ policy }`. This is because matcher checks not only presence of an error, but also ensures its message is translated to all available locales (`I18n.available_locales`). The block containing a policy will be executed separately for every such language.
+**Notice** that you have to wrap policy into block `{ policy }`. This is because the matcher checks not only presence of an error, but also ensures its message is translated to all available locales (`I18n.available_locales`). The block containing a policy will be executed separately for every such language.
 
 ## Generators
 
 The gem provides simple tool for scaffolding new policy along with RSpec test template.
 
 ```shell
-$ tram-policy user/readiness_policy -p user -o admin -v name_present email_present
+$ tram-policy user/readiness_policy -p user -o admin -v name_present:blank_name email_present:blank_email
 ```
 
 This will generate a policy class with specification compatible to both [RSpec][rspec] and [FactoryGirl][factory-girl]:
@@ -232,7 +262,13 @@ This will generate a policy class with specification compatible to both [RSpec][
 
 ```ruby
 # app/policies/user/readiness_policy.rb
+
+# TODO: describe the policy, its subject and context
 class User::ReadinessPolicy < Tram::Policy
+  # TODO: add default values     (default: -> { ... }),
+  #       coercers               (type: proc(&:to_s)),
+  #       and optional arguments (optional: true)
+  #       when necessary
   param  :user
   option :admin
 
@@ -242,13 +278,17 @@ class User::ReadinessPolicy < Tram::Policy
   private
 
   def name_present
-    return if true # modify condition
-    errors.add :name_present # add necessary tags
+    # TODO: define a condition
+    return if true
+    # TODO: add necessary tags
+    errors.add :blank_name
   end
 
   def email_present
-    return if true # modify condition
-    errors.add :email_present # add necessary tags
+    # TODO: define a condition
+    return if true
+    # TODO: add necessary tags
+    errors.add :blank_email
   end
 end
 ```
@@ -258,32 +298,46 @@ end
 ---
 en:
   user/readiness_policy:
-    name_present:  name_present
-    email_present: email_present
+    blank_name: translation missing
+    blank_email: translation missing
 ```
 
 ```ruby
 # spec/policies/user/readiness_policy_spec.rb
-RSpec.describe User::ReadinessPolicy do
-  let(:user) { build :user } # <- expected a factory
+require "spec_helper"
+# TODO: move it to spec_helper
+require "tram/policy/rspec"
 
-  subject(:policy) { described_class[user] }
+RSpec.describe User::ReadinessPolicy, ".[]" do
+  # TODO: either remove this line, or set another source for locales to check
+  let(:available_locales) { I18n.available_locales }
+  let(:user) { FactoryGirl.build :user }
 
-  it { is_expected.to be_valid }
+  it "is valid with proper arguments" do
+    expect { described_class[user] }.to be_valid
+  end
 
+  # TODO: check the description
   it "is invalid when not name_present" do
-    policy # modify it correspondingly
-    expect { policy }.to be_invalid_at # add tags to check
+    # TODO: modify some arguments
+    user = nil
+    # TODO: add necessary tags to focus the condition
+    expect { described_class[user] }.to be_invalid_at
   end
 
+  # TODO: check the description
   it "is invalid when not email_present" do
-    policy # modify it correspondingly
-    expect { policy }.to be_invalid_at # add tags to check
+    # TODO: modify some arguments
+    user = nil
+    # TODO: add necessary tags to focus the condition
+    expect { described_class[user] }.to be_invalid_at
   end
 end
 ```
 
-Later you can copy-paste that contexts to provide more edge case for testing your policies.
+Then you should go through all TODO-s and add necessary details.
+
+Later you can copy-paste examples to provide more edge case for testing your policies.
 
 Notice that RSpec matcher `be_invalid_at` checks at once:
 
@@ -291,7 +345,10 @@ Notice that RSpec matcher `be_invalid_at` checks at once:
 - that the error has given tags
 - that the error is translated to every available locale
 
-and provides full description for the essence of the failure.
+Its negation (`not_to be_invalid_at`) checks that no errors added with given tags.
+When called without tags, it checks that the policy is valid as a whole.
+
+Both matchers provide a full description for the essence of the failure.
 
 ## To Recap
 

data/bin/tram-policy

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
-require File.expand_path("lib/tram/policy/generator", Dir.pwd)
+require File.expand_path("../../lib/tram/policy/generator", __FILE__)
 
 Tram::Policy::Generator.start

data/lib/tram/policy.rb

@@ -8,6 +8,7 @@ module Tram
     require_relative "policy/inflector"
     require_relative "policy/error"
     require_relative "policy/errors"
+    require_relative "policy/validator"
 
     extend Dry::Initializer
 
@@ -17,8 +18,8 @@ module Tram
       # @param  [#to_sym, Array<#to_sym>] names
       # @return [self]
       #
-      def validate(*names)
-        @validators = validators | names.flatten.map(&:to_sym)
+      def validate(name, **opts)
+        validators[name.to_sym] = opts
         self
       end
 
@@ -34,12 +35,12 @@ module Tram
       private
 
       def validators
-        @validators ||= []
+        @validators ||= {}
       end
 
       def inherited(klass)
         super
-        klass.validate validators
+        validators.each { |name, opts| klass.validate name, opts }
       end
     end
 
@@ -107,7 +108,11 @@ module Tram
     def initialize(*)
       super
       @__scope__ = Inflector.underscore(self.class.name)
-      self.class.send(:validators).each { |name| send(name) }
+      self.class.send(:validators).each do |name, opts|
+        size = errors.count
+        send(name)
+        break if (errors.count > size) && opts[:stop_on_failure]
+      end
     end
   end
 end

data/lib/tram/policy/generator.rb

@@ -25,11 +25,25 @@ module Tram
                                 default: [],
                                 aliases: "-v",
                                 banner:  "validator[ validator]"
+      class_option :locales,    desc:    "list of available_locales",
+                                type:    :array,
+                                default: [],
+                                aliases: "-l",
+                                banner:  "en[ ru]"
 
       def self.source_root
         File.dirname(__FILE__)
       end
 
+      def set_available_locales
+        @available_locales = \
+          if Array(options[:locales]).any?
+            options[:locales]
+          else
+            ask("Enter available locales for translation:").scan(/\w{2}/)
+          end
+      end
+
       def generate_class
         template "generator/policy.erb", "app/policies/#{file}.rb"
       end
@@ -39,7 +53,8 @@ module Tram
           @locale = locale
           add_locale
           localize_policy
-          parsed_validators.each { |validator| localize_validator(validator) }
+          parsed_validators.sort_by { |v| v[:key] }
+                           .each { |validator| localize_validator(validator) }
         end
       end
 
@@ -48,6 +63,10 @@ module Tram
       end
 
       no_tasks do
+        def available_locales
+          @available_locales ||= []
+        end
+
         def klass
           @klass ||= Inflector.camelize name
         end
@@ -65,17 +84,17 @@ module Tram
         end
 
         def parsed_validators
-          @parsed_validators ||= options[:validators].map(&:downcase)
+          @parsed_validators ||= options[:validators].map do |str|
+            name, key = str.downcase.split(":")
+            { name: name, key: key || name }
+          end
         end
 
         def policy_signature
-          @policy_signature ||= \
+          @policy_signature ||= (
             parsed_params + \
             parsed_options.map { |option| "#{option}: #{option}" }
-        end
-
-        def available_locales
-          ask("What locales should be used for translation?").scan(/\w{2}/)
+          ).join(", ")
         end
 
         def locale_file
@@ -90,8 +109,8 @@ module Tram
           @locale_group ||= "  #{file}:\n"
         end
 
-        def locale_line(validator)
-          "    #{validator}: #{validator}\n"
+        def locale_line(key)
+          "    #{key}: translation missing\n"
         end
 
         def add_locale
@@ -102,8 +121,8 @@ module Tram
           append_to_file(locale_file, locale_group)
         end
 
-        def localize_validator(name)
-          insert_into_file locale_file, locale_line(name), after: locale_group
+        def localize_validator(key:, **)
+          insert_into_file locale_file, locale_line(key), after: locale_group
         end
       end
     end

data/lib/tram/policy/generator/policy.erb

@@ -1,4 +1,9 @@
+# TODO: describe the policy, its subject and context
 class <%= klass %> < Tram::Policy
+  # TODO: add default values     (default: -> { ... }),
+  #       coercers               (type: proc(&:to_s)),
+  #       and optional arguments (optional: true)
+  #       when necessary
 <% parsed_params.each do |param| -%>
   param :<%= param %>
 <% end -%>
@@ -7,14 +12,16 @@ class <%= klass %> < Tram::Policy
 <% end -%>
 
 <% parsed_validators.each do |validator| -%>
-  validate :<%= validator %>
+  validate :<%= validator[:name] %>
 <% end -%>
 
   private
 <% parsed_validators.each do |validator| %>
-  def <%= validator %>
-    return if true # define a condition
-    errors.add :<%= validator %> # add necessary tags
+  def <%= validator[:name] %>
+    # TODO: define a condition
+    return if true
+    # TODO: add necessary tags
+    errors.add :<%= validator[:key] %>
   end
 <% end -%>
 end

data/lib/tram/policy/generator/policy_spec.erb

@@ -1,17 +1,26 @@
 require "spec_helper"
+# TODO: move it to spec_helper
+require "tram/policy/rspec"
 
-RSpec.describe <%= klass %>, "#valid?" do
-  subject(:policy) { described_class[<%= policy_signature.join(", ") %>] }
-
+RSpec.describe <%= klass %>, ".[]" do
+  # TODO: either remove this line, or set another source for available locales
+  let(:available_locales) { I18n.available_locales }
 <% (parsed_params + parsed_options).each do |name| -%>
   let(:<%= name %>) { FactoryGirl.build :<%= name %> }
 <% end -%>
 
-  it { is_expected.to be_valid }
-<% parsed_validators.each do |validator| %>
-  it "is invalid when not <%= validator %>" do
-    policy # modify it correspondingly
-    expect { policy }.to be_invalid_at # add tags to check
+  it "is valid with proper arguments" do
+    expect { described_class[<%= policy_signature %>] }.not_to be_invalid_at
+  end
+<% parsed_validators.each do |v| %>
+  # TODO: fix default description
+  it "is invalid when <%= "not " if v[:key] == v[:name] %><%= v[:key] %>" do
+    # TODO: modify some arguments
+<% (parsed_params + parsed_options).each do |name| -%>
+    <%= name %> = nil
+<% end -%>
+    # TODO: add necessary tags to focus the condition
+    expect { described_class[<%= policy_signature %>] }.to be_invalid_at
   end
 <% end -%>
 end

data/lib/tram/policy/{matchers.rb → rspec.rb}

@@ -36,9 +36,13 @@ RSpec::Matchers.define :be_invalid_at do |**tags|
 
   # Runs block in every available locale
   def in_available_locales
-    Array(I18n.available_locales).flat_map do |locale|
-      I18n.with_locale(locale) { yield }
-    end
+    locales = if respond_to?(:available_locales)
+                available_locales
+              else
+                I18n.available_locales
+              end
+
+    locales.flat_map { |locale| I18n.with_locale(locale) { yield } }
   end
 
   # Collects results for the current locale
@@ -67,7 +71,7 @@ RSpec::Matchers.define :be_invalid_at do |**tags|
   # Checks if all collected errors are translated
   def translated?
     texts = errors.values.flatten.map(&:message)
-    texts.select { |text| text.start_with?("translation missing:") }.empty?
+    texts.select { |text| text.start_with?("translation missing") }.empty?
   end
 
   def report_errors
@@ -89,7 +93,8 @@ RSpec::Matchers.define :be_invalid_at do |**tags|
   end
 
   failure_message do |_|
-    text =  "#{policy} should have had errors with tags: #{tags}, "
+    text =  "The policy: #{policy}\n"
+    text << "should have had errors with tags: #{tags}, "
     text << "whose messages are translated in all available locales.\n"
     text << report_errors
     text
@@ -105,8 +110,22 @@ RSpec::Matchers.define :be_invalid_at do |**tags|
   end
 
   failure_message_when_negated do |_|
-    text =  "#{policy} should not have had any error with tags: #{tags}.\n"
+    text =  "#{policy}\nshould not have had any error with tags: #{tags}.\n"
     text << report_errors
     text
   end
 end
+
+RSpec.shared_examples :invalid_policy do |condition = nil, **tags|
+  constraint = "with tags: #{tags}" if tags.any?
+  it ["is invalid", condition, constraint].compact.join(" ") do
+    expect { subject }.to be_invalid_at(tags)
+  end
+end
+
+RSpec.shared_examples :valid_policy do |condition = nil, **tags|
+  constraint = "with tags: #{tags}" if tags.any?
+  it ["is valid", condition, constraint].compact.join(" ") do
+    expect { subject }.not_to be_invalid_at(tags)
+  end
+end

data/lib/tram/policy/validator.rb

@@ -0,0 +1,17 @@
+class Tram::Policy
+  # Describes a validator
+  class Validator
+    attr_reader :name, :stop_on_failure
+
+    def ==(other)
+      other.is_a?(self.class) && other.name == name
+    end
+
+    private
+
+    def initialize(name, stop_on_failure: false)
+      @name = name.to_sym
+      @stop_on_failure = stop_on_failure
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -5,7 +5,7 @@ rescue
 end
 require "bundler/setup"
 require "tram/policy"
-require "tram/policy/matchers"
+require "tram/policy/rspec"
 require "rspec/its"
 
 RSpec.configure do |config|
@@ -19,9 +19,6 @@ RSpec.configure do |config|
   config.run_all_when_everything_filtered = true
 
   # Prepare the Test namespace for constants defined in specs
-  config.around(:each) do |example|
-    Test = Class.new(Module)
-    example.run
-    Object.send :remove_const, :Test
-  end
+  config.before(:each) { Test = Class.new(Module) }
+  config.after(:each)  { Object.send :remove_const, :Test }
 end

data/spec/tram/policy/{matchers_spec.rb → rspec_spec.rb}

@@ -1,4 +1,4 @@
-RSpec.describe "RSpec matchers:" do
+RSpec.describe "RSpec support:" do
   subject { Test::UserPolicy[name: nil] }
 
   before do
@@ -67,4 +67,12 @@ RSpec.describe "RSpec matchers:" do
       end.to raise_error RSpec::Expectations::ExpectationNotMetError
     end
   end
+
+  describe "shared examples" do
+    it_behaves_like :invalid_policy
+    it_behaves_like :invalid_policy, field: "name" do
+      before { I18n.available_locales = %i[en ru] }
+    end
+    it_behaves_like :valid_policy,   field: "email"
+  end
 end

data/spec/tram/policy_spec.rb

@@ -5,7 +5,9 @@ RSpec.describe Tram::Policy do
     class Test::UserPolicy < Tram::Policy
       param :user
 
-      validate :name, "email", %w[email name]
+      validate :name
+      validate "email"
+      validate "name"
 
       private
 
@@ -53,6 +55,26 @@ RSpec.describe Tram::Policy do
 
       Test::AdminPolicy.new(user)
     end
+
+    context "when :stop_on_failure is set" do
+      before { Test::UserPolicy.validate :name, stop_on_failure: true }
+
+      it "stops validation after failure" do
+        expect(user).to receive(:name).once
+        expect(user).not_to receive(:email)
+
+        Test::UserPolicy.new(user)
+      end
+
+      it "continues validation after success" do
+        user = double :user, name: "Andy", email: nil, login: nil
+
+        expect(user).to receive(:name).once.ordered
+        expect(user).to receive(:email).once.ordered
+
+        Test::UserPolicy.new(user)
+      end
+    end
   end
 
   describe "#inspect" do

data/tram-policy.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name     = "tram-policy"
-  gem.version  = "0.0.1"
+  gem.version  = "0.0.2"
   gem.author   = ["Viktor Sokolov (gzigzigzeo)", "Andrew Kozin (nepalez)"]
   gem.email    = ["andrew.kozin@gmail.com"]
   gem.homepage = "https://github.com/tram/tram-policy"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tram-policy
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Viktor Sokolov (gzigzigzeo)
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-18 00:00:00.000000000 Z
+date: 2017-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-initializer
@@ -138,13 +138,14 @@ files:
 - lib/tram/policy/generator/policy.erb
 - lib/tram/policy/generator/policy_spec.erb
 - lib/tram/policy/inflector.rb
-- lib/tram/policy/matchers.rb
+- lib/tram/policy/rspec.rb
 - lib/tram/policy/validation_error.rb
+- lib/tram/policy/validator.rb
 - spec/spec_helper.rb
 - spec/tram/policy/error_spec.rb
 - spec/tram/policy/errors_spec.rb
 - spec/tram/policy/inflector_spec.rb
-- spec/tram/policy/matchers_spec.rb
+- spec/tram/policy/rspec_spec.rb
 - spec/tram/policy/validation_error_spec.rb
 - spec/tram/policy_spec.rb
 - tram-policy.gemspec
@@ -177,6 +178,6 @@ test_files:
 - spec/tram/policy/error_spec.rb
 - spec/tram/policy/errors_spec.rb
 - spec/tram/policy/inflector_spec.rb
-- spec/tram/policy/matchers_spec.rb
+- spec/tram/policy/rspec_spec.rb
 - spec/tram/policy/validation_error_spec.rb
 - spec/tram/policy_spec.rb