tram-policy 0.4.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7ffe8d541eb55eb7ba031f7578515523884d74a9
-  data.tar.gz: b0e194a4dcd4682c79526a024b60f574b32014ba
+  metadata.gz: 54f65bae74cb48be0cc7d481cb3abd8528f43749
+  data.tar.gz: 4a100e49ec40986bc4f8781304169e6ecd2d5baf
 SHA512:
-  metadata.gz: 9413e5c3d0bf479d3022ce75bbbcd639fee2ffa6632883859419b724ff7cb9b04c792b4118837f854714611b2db1756ca3294ead1767fc9ab669c8c7e0b8806c
-  data.tar.gz: 4be7c88f9c2e1bdb45c70c45c90367afe2b1a8616837ca121a07a769521c8e1c1e3bb29224678d2425a49473db4b6549f4d71b9d9ca0e3e8f2eb0d3715e19138
+  metadata.gz: 107d99cdd79742b7ae85b5b1f8783f5eb6114c864cbfb7732251c2a4542261effec81ec171d61dbc0da6787ca576efc581dae43f76f75ef4a16d2d7934edea9f
+  data.tar.gz: 3dc2b45735369a9097b525b1681ea8dee24ed84675bc8cfde67b1f87394647f345abedd45db4c12d3725d3cd56df8193e70b8c92e5ec62e9e1c14970097c6ee8

data/CHANGELOG.md

@@ -4,6 +4,27 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [1.0.0] - [2018-02-17]
+
+### Changed
+- RSpec matchers does't use blocks any more (nepalez)
+
+  Instead of
+
+  ```ruby
+  expect { policy }.to be_invalid_at level: "error"
+  ```
+
+  use the simpler syntax
+
+  ```ruby
+  expect(policy).to be_invalid_at level: "error"
+  ```
+
+### Deleted
+- Deprecated methods (nepalez)
+- RSpec shared examples (nepalez)
+
 ## [0.4.0] - [2018-02-17]
 
 This is beta-release before the first stable version 1.0.0.

data/README.md

@@ -285,123 +285,30 @@ require "tram/policy/rspec"
 ```ruby
 # spec/policies/user/readiness_policy_spec.rb
 RSpec.describe User::ReadinessPolicy do
-  let(:user) { build :user } # <- expected a factory
-
   subject(:policy) { described_class[email: "user@example.com"] }
 
-  it "is invalid with 'error' level" do
-    expect { policy }.to be_invalid_at level: "error"
-  end
+  let(:user) { build :user } # <- expected a factory
 
-  it "is not invalid with 'info' level" do
-    expect { policy }.not_to be_invalid_at level: "info"
-  end
+  it { is_expected.to be_invalid }
+  it { is_expected.to be_invalid_at level: "error" }
+  it { is_expected.to be_valid_at   level: "info" }
 end
 ```
 
-**Notice** that you have to wrap policy into block `{ policy }`. This is because the matcher checks not only the 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.
+The matcher checks not only the presence of an error, but also ensures that you provided translation of any message to any available locale (`I18n.available_locales`).
 
 ## Generators
 
-The gem provides simple tool for scaffolding new policy along with RSpec test template.
+The gem provides simple tool for scaffolding new policy along with its RSpec test template and translations.
 
 ```shell
 $ 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]:
-
-
-```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
-
-  validate :name_present
-  validate :email_present
-
-  private
-
-  def name_present
-    # TODO: define a condition
-    return if true
-    # TODO: add necessary tags
-    errors.add :blank_name
-  end
-
-  def email_present
-    # TODO: define a condition
-    return if true
-    # TODO: add necessary tags
-    errors.add :blank_email
-  end
-end
-```
-
-```yaml
-# config/tram-policies.en.yml
----
-en:
-  tram-policy:
-    user/readiness_policy:
-      blank_name: translation missing
-      blank_email: translation missing
-```
-
-```ruby
-# spec/policies/user/readiness_policy_spec.rb
-require "spec_helper"
-# TODO: move it to spec_helper
-require "tram/policy/rspec"
-
-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 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
-    # 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
-    # TODO: modify some arguments
-    user = nil
-    # TODO: add necessary tags to focus the condition
-    expect { described_class[user] }.to be_invalid_at
-  end
-end
-```
-
-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:
-
-- that an error is added to the policy
-- that the error has given tags
-- that the error is translated to every available locale
-
-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.
+This will generate a policy class with specification compatible to both [RSpec][rspec] and [FactoryBot][factory_bot].
 
-Both matchers provide a full description for the essence of the failure.
+Under the keys `-p` and `-o` define params and options of the policy.
+Key `-v` should contain validation methods along with their error message keys.
 
 ## Installation
 
@@ -443,4 +350,4 @@ The gem is available as open source under the terms of the [MIT License](http://
 [dry-initializer]: http://dry-rb.org/gems/dry-initializer/
 [i18n]: https://github.com/svenfuchs/i18n
 [rspec]: http://rspec.info/
-[factory-girl]: https://github.com/thoughtbot/factory_girl
+[factory_bot]: https://github.com/thoughtbot/factory_bot

data/lib/tram/policy/error.rb

@@ -44,30 +44,6 @@ class Tram::Policy
       key.is_a?(Symbol) ? I18n.t(*item) : key.to_s
     end
 
-    # @deprecated
-    # Converts the error to a hash of message and tags
-    #
-    # @return [Hash<Symbol, Object>]
-    #
-    def to_h
-      warn "[DEPRECATED] The method Tram::Policy::Error#to_h" \
-           " will be removed in the v1.0.0.."
-
-      tags.reject { |k| k == :scope }.merge(message: message)
-    end
-
-    # @deprecated
-    # The full message (message and tags info)
-    #
-    # @return [String]
-    #
-    def full_message
-      warn "[DEPRECATED] The method Tram::Policy::Error#full_message" \
-           " will be removed in the v1.0.0."
-
-      [message, tags].reject(&:empty?).join(" ")
-    end
-
     # Fetches an option
     #
     # @param [#to_sym] tag

data/lib/tram/policy/errors.rb

@@ -50,20 +50,6 @@ class Tram::Policy
       self.class.new(policy, list)
     end
 
-    # @deprecated
-    # @!method by_tags(tags)
-    # Selects errors filtered by key and tags
-    #
-    # @param  [Hash<Symbol, Object>] tags List of options to filter by
-    # @return [Array<Tram::Policy::Error>]
-    #
-    def by_tags(**tags)
-      warn "[DEPRECATED] The method Tram::Policy::Errors#by_tags" \
-           " will be removed in the v1.0.0. Use method #filter instead."
-
-      filter(tags).to_a
-    end
-
     # @!method empty?
     # Checks whether a collection is empty
     #
@@ -89,18 +75,6 @@ class Tram::Policy
       @set.map(&:message).sort
     end
 
-    # @deprecated
-    # List of error descriptions
-    #
-    # @return [Array<String>]
-    #
-    def full_messages
-      warn "[DEPRECATED] The method Tram::Policy::Errors#full_messages" \
-           " will be removed in the v1.0.0."
-
-      map(&:full_message)
-    end
-
     # @!method merge(other, options)
     # Merges other collection to the current one and returns new collection
     # with the current scope

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

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

data/lib/tram/policy/rspec.rb

@@ -1,125 +1,76 @@
 require "rspec"
 
-# Checks that a block provides policy that has errors under given tags
-# It also check that selected messages has translations to all available locales
-#
-# @example
-#   subject(:policy) { UserPolicy[name: nil] }
-#   expect { policy }.to be_invalid_at field: "name", level: "error"
-#
-# You have to wrap expectation to a block called for available locales.
-#
 RSpec::Matchers.define :be_invalid_at do |**tags|
-  supports_block_expectations
-
-  # ****************************************************************************
-  # Result collectors for all available locations
-  # ****************************************************************************
-
-  attr_accessor :policy
-
-  def errors
-    @errors ||= {}
+  def locales
+    @locales ||= I18n.available_locales
   end
 
-  def tags
-    @tags ||= {}
-  end
-
-  # ****************************************************************************
-  # Helpers to provide results for all locales
-  # ****************************************************************************
-
-  def prepare_localized_results(policy_block, tags, locale)
-    I18n.locale    = locale
-    local_policy   = policy_block.call
-    self.policy    = local_policy.inspect
-    errors[locale] = local_policy&.errors&.filter(tags)&.map do |error|
-      { message: error.message, tags: error.options } # translate immediately
+  def check(policy, tags)
+    @errors ||= policy.errors.filter(tags).map do |error|
+      { item: error.item }.tap do |obj|
+        locales.each { |l| obj[l] = I18n.with_locale(l) { error.message } }
+      end
     end
   end
 
-  def prepare_results(policy_block, tags)
-    original = I18n.locale
-    I18n.available_locales.each do |locale|
-      prepare_localized_results(policy_block, tags, locale)
-    end
-  ensure
-    I18n.locale = original
-  end
-
-  # ****************************************************************************
-  # Checkers for collected results
-  # ****************************************************************************
-
-  # Checks if selected errors are present in all available locales
-  def errored?
-    errors.values.map(&:any?).reduce(true, &:&) == true
-  end
-
-  # Checks if selected errors are absent in all available locales
-  def not_errored?
-    errors.values.map(&:empty?).reduce(true, &:&) == true
-  end
+  attr_reader :errors
 
-  # Checks if all collected errors are translated
-  def translated?
-    texts = errors.values.flatten.map { |err| err[:message] }
-    texts.select { |text| text.start_with?("translation missing") }.empty?
+  def missed_translations
+    @missed_translations ||= \
+      errors.flat_map { |rec| rec.values_at(*locales) }
+            .select { |message| message.start_with? "translation missing" }
   end
 
   def report_errors
-    text = "Actual errors:\n"
-    errors.each do |locale, local_errors|
-      text << "  #{locale}:\n"
-      local_errors&.each { |err| text << "  - #{err.values.join(" ")}\n" }
+    locales.each_with_object("Actual errors:\n") do |loc, text|
+      text << "  #{loc}:\n"
+      errors.each { |err| text << "  - #{err[loc]} #{err[:item]}\n" }
     end
-    text
   end
 
-  # ****************************************************************************
-  # Positive matcher
-  # ****************************************************************************
+  match do |policy|
+    check(policy, tags)
+    errors.any? && missed_translations.empty?
+  end
 
-  match do |policy_block|
-    prepare_results(policy_block, tags)
-    errored? && translated?
+  match_when_negated do |policy|
+    check(policy, tags)
+    errors.empty?
   end
 
-  failure_message do |_|
+  failure_message do |policy|
+    desc = tags.any? ? " 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 << " should have had errors#{desc},"
+    text << " whose messages are translated in all available locales.\n"
     text << report_errors
     text
   end
 
-  # ****************************************************************************
-  # Negative matcher
-  # ****************************************************************************
-
-  match_when_negated do |policy_block|
-    prepare_results(policy_block, tags)
-    not_errored?
-  end
-
-  failure_message_when_negated do |_|
-    text =  "#{policy}\nshould not have had any error with tags: #{tags}.\n"
+  failure_message_when_negated do |policy|
+    desc = tags.any? ? " with tags: #{tags}" : ""
+    text =  "#{policy}\nshould not have had any error#{desc}.\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)
+RSpec::Matchers.define :be_invalid do
+  match do |policy|
+    expect(policy).to be_invalid_at
+  end
+
+  match_when_negated do |policy|
+    expect(policy).not_to be_invalid_at
   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)
+RSpec::Matchers.define :be_valid_at do |**tags|
+  match do |policy|
+    expect(policy).not_to be_invalid_at(tags)
+  end
+
+  match_when_negated do |policy|
+    expect(policy).to be_invalid_at(tags)
   end
 end

data/spec/tram/policy/rspec_spec.rb

@@ -1,62 +1,49 @@
 RSpec.describe "RSpec support:" do
+  subject { Test::CustomerPolicy[name: nil] }
+
   before do
     I18n.available_locales = %i[en]
     I18n.backend.store_translations :en, yaml_fixture_file("en.yml")["en"]
     load_fixture "customer_policy.rb"
   end
 
-  subject { Test::CustomerPolicy[name: nil] }
-
   describe "to be_invalid_at" do
     it "passes when some translated error present w/o tags constraint" do
-      expect do
-        expect { subject }.to be_invalid_at
-      end.not_to raise_error
+      expect { expect(subject).to be_invalid_at }.not_to raise_error
     end
 
     it "passes when some translated error present under given tags" do
-      expect do
-        expect { subject }.to be_invalid_at field: "name"
-      end.not_to raise_error
+      expect { expect(subject).to be_invalid_at field: "name" }
+        .not_to raise_error
     end
 
     it "fails when no errors present under given tags" do
-      expect do
-        expect { subject }.to be_invalid_at field: "email"
-      end.to raise_error RSpec::Expectations::ExpectationNotMetError
+      expect { expect(subject).to be_invalid_at field: "email" }
+        .to raise_error RSpec::Expectations::ExpectationNotMetError
     end
 
     it "fails when some translations are absent" do
       I18n.available_locales = %i[ru en]
 
-      expect do
-        expect { subject }.to be_invalid_at field: "name"
-      end.to raise_error RSpec::Expectations::ExpectationNotMetError
+      expect { expect(subject).to be_invalid_at field: "name" }
+        .to raise_error RSpec::Expectations::ExpectationNotMetError
     end
   end
 
   describe "not_to be_invalid_at" do
     it "passes when no errors present under given tags" do
-      expect do
-        expect { subject }.not_to be_invalid_at field: "email"
-      end.not_to raise_error
+      expect { expect(subject).not_to be_invalid_at field: "email" }
+        .not_to raise_error
     end
 
     it "fails when some error present under given tags" do
-      expect do
-        expect { subject }.not_to be_invalid_at field: "name"
-      end.to raise_error RSpec::Expectations::ExpectationNotMetError
+      expect { expect(subject).not_to be_invalid_at field: "name" }
+        .to raise_error RSpec::Expectations::ExpectationNotMetError
     end
 
     it "fails when some error present w/o tags constraint" do
-      expect do
-        expect { subject }.not_to be_invalid_at
-      end.to raise_error RSpec::Expectations::ExpectationNotMetError
+      expect { expect(subject).not_to be_invalid_at }
+        .to raise_error RSpec::Expectations::ExpectationNotMetError
     end
   end
-
-  describe "shared examples" do
-    it_behaves_like :invalid_policy
-    it_behaves_like :valid_policy, field: "email"
-  end
 end

data/tram-policy.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name     = "tram-policy"
-  gem.version  = "0.4.0"
+  gem.version  = "1.0.0"
   gem.author   = ["Viktor Sokolov (gzigzigzeo)", "Andrew Kozin (nepalez)"]
   gem.email    = "andrew.kozin@gmail.com"
   gem.homepage = "https://github.com/tram/tram-policy"
@@ -15,7 +15,7 @@ Gem::Specification.new do |gem|
   gem.required_ruby_version = ">= 2.3"
 
   gem.add_runtime_dependency "dry-initializer", "~> 2.0"
-  gem.add_runtime_dependency "i18n", "~> 0.8"
+  gem.add_runtime_dependency "i18n", "~> 1.0"
 
   gem.add_development_dependency "rake", "> 10"
   gem.add_development_dependency "rspec", "~> 3.0"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tram-policy
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Viktor Sokolov (gzigzigzeo)
@@ -31,14 +31,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement