policy 1.0.5 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 707dc12513a50ae6567790a05ea8ab848f7055e0
-  data.tar.gz: f28991b4dad44e835bfa43790b49fa3798a64921
+  metadata.gz: c43acc2f25d6b3056f4702697e77e317b6aca3e2
+  data.tar.gz: b79816c8eb97f48bfab2e17269942b88bec0f3f2
 SHA512:
-  metadata.gz: ffe5458110d6d8fd68558fe42018f9c3ad27559f1444ded2cd1b0e46b3d7ac0938b68b8bbec5326ef0cbd58ea887e3571c48f64ee1397a82e4965be5c1a83bba
-  data.tar.gz: cbe8335492c764aeaf6477470b848ecf4b3f21bf211681fcd06be7a3e05c430092fba3d9cd4f969f7edd6416c714c964bb9acbcbf16118917af8225493b70521
+  metadata.gz: de03f24c1ef2c65f67e6ad2a1f10c62da9e9cb31e47fa4860ed4e38fa02b887777bea518a885cd5a5ddd447e5292990b422fb8740344f79a1d66f2bee82b8ce4
+  data.tar.gz: 0903e3428ce0f25221340ff9f9ea7919f32f811204448da80cbd31f697e75b7f846e2116a4d2bc7be7a8d1759d9df0bc7de1b82216c52ca75d908677ee5a4544

data/.metrics

@@ -1,5 +1,8 @@
 # Settings for metric_fu and its packages are collected in the `config/metrics`
 # and loaded by the Hexx::Suit::Metrics::MetricFu.
 
-require "hexx-suit"
-Hexx::Suit::Metrics::MetricFu.load
+begin
+  require "hexx-suit"
+  Hexx::Suit::Metrics::MetricFu.load
+rescue LoadError
+end

data/Guardfile

@@ -6,6 +6,8 @@ guard :rspec, cmd: "bundle exec rspec" do
 
   watch("lib/policy.rb") { "spec" }
 
+  watch("lib/policy/cli/*.*") { "spec/tests/policy/cli_spec.rb" }
+
   watch(/^lib(.+)\.rb$/) do |m|
     "spec/tests#{ m[1] }_spec.rb"
   end

data/README.md

@@ -101,6 +101,20 @@ end
 
 Note a policy knows nothing about the complex nature of its attributes until their quack like transactions with `#sum` method defined.
 
+### Scaffolding a Policy
+
+You can scaffold the policy with its specification and necessary translations using the generator:
+
+```
+policy new
+```
+
+For a list of available options call the generator with a `-h` option:
+
+```
+policy new -h
+```
+
 [Struct]: http://ruby-doc.org//core-2.2.0/Struct.html
 [ActiveModel::Validations]: http://apidock.com/rails/ActiveModel/Validations
 

data/bin/policy

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+require "policy/cli"
+
+# Scaffolders runner from the command line
+class CLI < Thor
+
+  register(
+    Policy::CLI,
+    "new",
+    "new NAME[ -a attribute[ attribute]][ -l en[ ru]][ -n namespace]",
+    "Scaffolds a policy object with a specification and translations."
+  )
+
+end # class CLI
+
+CLI.start

data/lib/policy/cli/locale.erb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+# Translations for error messages, generated by policy objects of type:
+# <%= policy.type %>
+---
+# <%= @locale %>:
+#   activemodel:
+#     errors:
+#       models:
+#         <%= policy.path %>:
+#           attributes:
+#             base:
+<% attributes.each do |item| -%>
+#             <%= item %>:
+<% end -%>

data/lib/policy/cli/policy.erb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+<% tabs = 0 -%>
+<% policy.namespaces.each do |item| -%>
+
+<%= "  " * tabs %>module <%= item %>
+<% tabs += 1 -%>
+<% end -%>
+
+<%= "  " * tabs %># Implements the following policy (invariant):
+<%= "  " * tabs %>#
+<%= "  " * tabs %># @todo: describe the policy
+<%= "  " * tabs %>#
+<%= "  " * tabs %># @example
+<%= "  " * tabs %>#   <%= policy.type %>.new(<%= attributes.join(", ") %>)
+<%= "  " * tabs %>#
+<% attributes.each do |item| -%>
+<%= "  " * tabs %># @param [@todo] <%= item %>
+<%= "  " * tabs %>#   @todo: describe the attribute
+<% end -%>
+<%= "  " * tabs %>class <%= policy.const %> < Hexx::Policy.new(<%= attributes.map { |item| ":#{ item }" }.join(", ") %>)
+
+<%= "  " * tabs %>  # Define necessary validations using `validates` or `validate` declarations.
+
+<%= "  " * tabs %>end # class <%= policy.const %>
+<% policy.namespaces.reverse.each do |item| -%>
+
+<% tabs -= 1 -%>
+<%= "  " * tabs %>end # module <%= item %>
+<% end -%>

data/lib/policy/cli/spec.erb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+describe <%= policy.type %> do
+
+  # The specification checks whether the policy object is valid or not,
+  # depending on values of its attributes.
+
+  # default attributes for a valid policy
+<% attributes.each do |item| -%>
+  # let(:<%= item %>) { @todo }
+<% end -%>
+
+  subject { described_class.new <%= attributes.join(", ") %> }
+
+  context "when @todo: describe the context" do
+
+    it { is_expected.to be_valid }
+
+  end # context
+<% attributes.each do |item| -%>
+
+  context "when <%= item %> @todo" do
+
+    # let(:<%= item %>) { @todo }
+    it { is_expected.not_to be_valid }
+
+  end # context
+<% end -%>
+
+end # describe <%= policy.type %>

data/lib/policy/cli.rb

@@ -0,0 +1,85 @@
+# encoding: utf-8
+require "hexx-cli"
+
+module Policy
+
+  # Scaffolds a policy with a specification and translations
+  class CLI < Hexx::CLI::Base
+
+    # @private
+    def self.source_root
+      ::File.expand_path "../cli", __FILE__
+    end
+
+    desc "Scaffolds a policy object with a specification and translations."
+    namespace :new
+
+    argument(
+      :name,
+      banner: "NAME",
+      desc: "The name of the policy.",
+      type: :string
+    )
+
+    class_option(
+      :attributes,
+      aliases: %w(-a),
+      banner: " debet credit",
+      default: %w(),
+      desc: "The list of attributes of the policy (the order is essential).",
+      type: :array
+    )
+
+    class_option(
+      :namespace,
+      aliases: %w(-n),
+      banner: " policies financial",
+      default: %w(policies),
+      desc: "The namespace for the policy.",
+      type: :array
+    )
+
+    class_option(
+      :locales,
+      aliases: %w(-l),
+      banner:  " en jp",
+      default: %w(en ru),
+      desc: "The list of locales for policy messages' translations.",
+      type: :array
+    )
+
+    # @private
+    def add_spec
+      template "spec.erb", "spec/tests/#{ policy.path }_spec.rb"
+    end
+
+    # @private
+    def add_policy
+      template "policy.erb", "app/#{ policy.path }.rb"
+    end
+
+    # @private
+    def add_locales
+      locales.each do |locale|
+        @locale = locale
+        template "locale.erb", "config/locales/#{ policy.path }/#{ locale }.yml"
+      end
+    end
+
+    private
+
+    def policy
+      @policy ||= Hexx::CLI::Name.new [options[:namespace], name].join("/")
+    end
+
+    def attributes
+      @attributes ||= options[:attributes].map(&:downcase)
+    end
+
+    def locales
+      @locales ||= options[:locales].map(&:downcase)
+    end
+
+  end # class CLI
+
+end # module Policy

data/lib/policy/version.rb

@@ -4,6 +4,6 @@ module Policy
 
   # The semantic version of the module.
   # @see http://semver.org/ Semantic versioning 2.0
-  VERSION = "1.0.5".freeze
+  VERSION = "1.1.0".freeze
 
 end # module Hexx

data/policy.gemspec

@@ -13,6 +13,7 @@ Gem::Specification.new do |gem|
   gem.license     = "MIT"
 
   gem.files            = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  gem.executables      = ["policy"]
   gem.test_files       = Dir["spec/**/*.rb"]
   gem.extra_rdoc_files = Dir["README.md", "LICENSE"]
   gem.require_paths    = ["lib"]
@@ -20,6 +21,7 @@ Gem::Specification.new do |gem|
   gem.required_ruby_version = "~> 2.0"
   gem.add_runtime_dependency "activemodel", ">= 3.1"
   gem.add_runtime_dependency "adamantium", "~> 0.2"
-  gem.add_development_dependency "hexx-rspec", "~> 0.1"
+  gem.add_runtime_dependency "hexx-cli", "~> 0.0"
+  gem.add_development_dependency "hexx-rspec", "~> 0.3"
 
 end # Gem::Specification

data/spec/tests/bin/policy_spec.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+describe "$ policy new", :sandbox, :capture do
+
+  let(:argv) { %w(foo) }
+
+  before { try_in_sandbox { `policy new #{ argv.join(" ") }` } }
+
+  it "runs a scaffolder" do
+    %w(
+      app/policies/foo.rb
+      config/locales/policies/foo/en.yml
+      config/locales/policies/foo/ru.yml
+      spec/tests/policies/foo_spec.rb
+    ).each { |file| expect(file).to be_present_in_sandbox }
+  end
+
+end # describe $ policy new

data/spec/tests/policy/cli_spec.rb

@@ -0,0 +1,127 @@
+# encoding: utf-8
+require "policy/cli"
+
+describe Policy::CLI, :sandbox, :capture do
+
+  describe ".start" do
+
+    subject { try_in_sandbox { described_class.start options } }
+
+    shared_examples "adding a policy" do |folder:|
+
+      let(:filename) { File.join("app", folder, "foo.rb") }
+
+      it "[creates file]" do
+        expect(filename).to be_present_in_sandbox
+      end
+
+    end # examples
+
+    shared_examples "adding a spec" do |folder:|
+
+      let(:filename) { File.join("spec/tests", folder, "foo_spec.rb") }
+
+      it "[creates file]" do
+        expect(filename).to be_present_in_sandbox
+      end
+
+    end # examples
+
+    shared_examples "adding locales" do |locales, folder:|
+
+      let(:dirname) { File.join("config/locales", folder, "foo") }
+
+      it "[creates files]" do
+        locales.each do |locale|
+          expect("#{ dirname }/#{ locale }.yml").to be_present_in_sandbox
+        end
+      end
+
+    end # examples
+
+    context "foo" do
+
+      let(:options) { %w(foo) }
+      before { subject }
+
+      it_behaves_like "adding a policy", folder: "policies"
+      it_behaves_like "adding a spec", folder: "policies"
+      it_behaves_like "adding locales", %w(en ru), folder: "policies"
+
+    end # context
+
+    context "foo -a bar baz" do
+
+      let(:options) { %w(foo -a bar baz) }
+      before { subject }
+
+      it_behaves_like "adding a policy", folder: "policies"
+      it_behaves_like "adding a spec", folder: "policies"
+      it_behaves_like "adding locales", %w(en ru), folder: "policies"
+
+      it "adds attributes to the policy" do
+        content = read_in_sandbox "app/policies/foo.rb"
+        expect(content).to include "class Foo < Hexx::Policy.new(:bar, :baz)"
+      end
+
+      it "checks attributes" do
+        content = read_in_sandbox "spec/tests/policies/foo_spec.rb"
+        expect(content).to include "let(:bar) {"
+        expect(content).to include "let(:baz) {"
+      end
+
+    end # context
+
+    context "foo -n bar/baz" do
+
+      let(:options) { %w(foo -n bar/baz) }
+      before { subject }
+
+      it_behaves_like "adding a policy", folder: "bar/baz"
+      it_behaves_like "adding a spec", folder: "bar/baz"
+      it_behaves_like "adding locales", %w(en ru), folder: "bar/baz"
+
+      it "adds namespace to the policy" do
+        content = read_in_sandbox "app/bar/baz/foo.rb"
+        expect(content).to include "module Bar"
+        expect(content).to include "  module Baz"
+      end
+
+      it "describes the specification" do
+        content = read_in_sandbox "spec/tests/bar/baz/foo_spec.rb"
+        expect(content).to include "describe Bar::Baz::Foo do"
+      end
+
+      it "creates the proper locale" do
+        content = read_in_sandbox "config/locales/bar/baz/foo/en.yml"
+        expect(content).to include "# en:"
+        expect(content).to include " bar/baz/foo:"
+      end
+
+    end # context
+
+    context "foo -n bar baz" do
+
+      let(:options) { %w(foo -n bar baz) }
+      before { subject }
+
+      it_behaves_like "adding a policy", folder: "bar/baz"
+      it_behaves_like "adding a spec", folder: "bar/baz"
+      it_behaves_like "adding locales", %w(en ru), folder: "bar/baz"
+
+    end # context
+
+    context "foo -l ua jp" do
+
+      let(:options) { %w(foo -l ua jp) }
+      before { subject }
+
+      it_behaves_like "adding a policy", folder: "policies"
+      it_behaves_like "adding a spec", folder: "policies"
+      it_behaves_like "adding locales", %w(ua jp), folder: "policies"
+
+    end # context
+
+  end # describe .start
+
+end # describe Policy::CLI

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: policy
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.1.0
 platform: ruby
 authors:
 - Andrew Kozin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-16 00:00:00.000000000 Z
+date: 2015-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -38,23 +38,38 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: hexx-cli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
 - !ruby/object:Gem::Dependency
   name: hexx-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.3'
 description: A tiny library implementing the Policy Object pattern.
 email: andrew.kozin@gmail.com
-executables: []
+executables:
+- policy
 extensions: []
 extra_rdoc_files:
 - README.md
@@ -72,6 +87,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- bin/policy
 - config/metrics/STYLEGUIDE
 - config/metrics/cane.yml
 - config/metrics/churn.yml
@@ -85,6 +101,10 @@ files:
 - config/metrics/simplecov.yml
 - config/metrics/yardstick.yml
 - lib/policy.rb
+- lib/policy/cli.rb
+- lib/policy/cli/locale.erb
+- lib/policy/cli/policy.erb
+- lib/policy/cli/spec.erb
 - lib/policy/follower.rb
 - lib/policy/follower/followed_policies.rb
 - lib/policy/follower/followed_policy.rb
@@ -96,6 +116,8 @@ files:
 - policy.gemspec
 - spec/features/follower_spec.rb
 - spec/spec_helper.rb
+- spec/tests/bin/policy_spec.rb
+- spec/tests/policy/cli_spec.rb
 - spec/tests/policy/follower/followed_policies_spec.rb
 - spec/tests/policy/follower/followed_policy_spec.rb
 - spec/tests/policy/follower/names_spec.rb
@@ -131,6 +153,8 @@ summary: Policy Objects for Ruby.
 test_files:
 - spec/spec_helper.rb
 - spec/tests/policy_spec.rb
+- spec/tests/bin/policy_spec.rb
+- spec/tests/policy/cli_spec.rb
 - spec/tests/policy/follower_spec.rb
 - spec/tests/policy/interface_spec.rb
 - spec/tests/policy/validations_spec.rb