hexx 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c91a43fe5d06b1d017e5361a82e3c6ea6fa6a82
-  data.tar.gz: 117f0a4bbe5433c6735d964fe1e180fda9b5a257
+  metadata.gz: d65195d201714af776e125147d354a379dac49f6
+  data.tar.gz: 8cae2ca8e5922850e7287688dee8997c3f7a0576
 SHA512:
-  metadata.gz: 2e3dd4e4d761336d330861d7ec3e48a51941c5ae8400edc3f325d390deaee1549946b78e398287d1b0b2897a8bf2e1753f5bdf3afc890d57433fcf78c6d597ce
-  data.tar.gz: 72eedbc4ba915c1865096d77a195cbc4e96e912b57fad709cf47d3bc115cf47c00ab58e0e8a6f7a6e5deb07bceabfe835fa4f23686c54e0236e67dfd56a16691
+  metadata.gz: 627cba9adf41b1c286efe70c45edcc347a440bc1866453ca8ccb01bee057cbbf1a5e14a3be9c4e6203d1d304b411eb659e1357490db1740173847bf96338731b
+  data.tar.gz: 65bdbf6099b498c3600f18c2034e49d3d6f4064ec5a6dcd124efc0cba29125e912d113d1f0cff1a569fd67166e55225a75887d2bdc00bcae1109abb0a9cf2861

data/.rubocop.yml

@@ -6,6 +6,10 @@ Lint/RescueException:
   Exclude:
     - 'spec/**/*'
 
+Metrics/ClassLength:
+  Exclude:
+    - 'lib/generators/**/*.rb'
+
 Style/AccessorMethodName:
   Exclude:
     - 'spec/**/*'

data/lib/generators/controller/templates/routing_action_spec.erb

@@ -4,7 +4,7 @@
     #   let(:action) do
     #     { controller: "<%= gem_name %>/#{ root }", action: "<%= action_name %>" }
     #   end
-    
+
     #   subject(:request) { { <%= action_type %>: "/#{ root }/something" } }
 
     #   it "is routable in json" do

data/lib/generators/install/install.rb

@@ -15,119 +15,48 @@ module Hexx
 
       argument :name
 
-      def remove_app
+      def remove_app_folder
         run "rm app -f -r"
       end
 
-      def update_bin
+      def update_bin_files
         template "bin/rails.erb", "bin/rails", force: true
       end
 
-      def update_config
-        template "config/routes.erb", "config/routes.rb", force: true
+      def add_config_files
         run "mkdir config/locales -p -v"
+        template "config/routes.erb", "config/routes.rb", force: true
       end
 
-      def update_lib
-        template "lib/lib.erb", "lib/#{ gem_name }.rb", force: true
-        %w(engine version).each do |name|
-          template(
-            "lib/#{ name }.erb",
-            "lib/#{ gem_name }/#{ name }.rb",
-            force: true
-          )
-        end
-      end
-
-      def add_tasks
+      def add_lib_files
         run "mkdir lib/tasks -p -v"
-        template "lib/task", "lib/tasks/install.rb", force: true
-      end
-
-      def add_spec_helper
-        template(
-          "spec/spec_helper.erb",
-          "spec/spec_helper.rb",
-          force: true
-        )
-      end
-
-      def add_spec_initializers
-        initializers.each do |name|
-          template(
-            "spec/#{ name }.erb",
-            "spec/support/initializers/#{ name }.rb",
-            force: true
-          )
-        end
-      end
-
-      def add_spec_matchers
-        matchers.each do |name|
-          template(
-            "spec/#{ name }.erb",
-            "spec/support/matchers/#{ name }.rb",
-            force: true
-          )
-        end
-      end
-
-      def add_json_schemas_path
-        run "mkdir spec/requests/json_schemas/messages -p -v"
-      end
-
-      def add_get_errors_json_schema
-        template(
-          "json_schemas/get_errors.erb",
-          "spec/requests/json_schemas/get_errors.json",
-          force: true
-        )
+        install_from_templates lib_files
       end
 
-      def add_messages_json_schemas
-        %w(error success).each do |type|
-          template(
-            "json_schemas/#{ type }.erb",
-            "spec/requests/json_schemas/messages/#{ type }.json",
-            force: true
-          )
-        end
+      def add_spec_files
+        run "mkdir spec/requests/json_schemas/shared -p -v"
+        template "spec/spec_helper.erb", "spec/spec_helper.rb", force: true
+        install_from_templates spec_initializers
+        install_from_templates matchers_files
+        install_from_templates json_files
       end
 
-      def add_services
-        template "coveralls.erb", ".coveralls.yml", force: true
-        template "gitignore.erb", ".gitignore", force: true
-        template "rspec.erb", ".rspec", force: true
-        template "rubocop.erb", ".rubocop.yml", force: true
-        template "travis.erb", ".travis.yml", force: true
-        template "Rakefile.erb", "Rakefile", force: true
-        template "Guardfile.erb", "Guardfile", force: true
-      end
-
-      def add_docs
-        template "CHANGELOG.erb", "CHANGELOG.rdoc", force: true
+      def add_root_files
         run "rm MIT-LICENSE -f -r"
-        template "LICENSE.erb", "LICENSE.rdoc", force: true
-        template "README.erb", "README.rdoc", force: true
-      end
-
-      def update_settings
-        template "Gemfile.erb", "Gemfile", force: true
-        template(
-          "gemspec.erb",
-          "#{ gem_name }.gemspec",
-          force: true
-        )
+        install_from_templates settings_files
+        install_from_templates root_files
       end
 
       def run_docs
-        run "subl README.rdoc" \
-            " lib/#{ gem_name }.rb" \
-            " #{ gem_name }.gemspec"
+        run "subl README.rdoc lib/#{ gem_name }.rb #{ gem_name }.gemspec"
       end
 
       private
 
+      def install_from_templates(hash)
+        hash.each { |erb, file| template erb, file, force: true }
+      end
+
       def gem_name
         @gem_name ||= name.snake_case
       end
@@ -136,16 +65,68 @@ module Hexx
         @module_name ||= name.camel_case
       end
 
+      def lib_files
+        @lib_files ||= {
+          "lib/lib.erb"     => "lib/#{ gem_name }.rb",
+          "lib/engine.erb"  => "lib/#{ gem_name }/engine.rb",
+          "lib/version.erb" => "lib/#{ gem_name }/version.rb",
+          "lib/task"        => "lib/tasks/#{ gem_name }_install.rb"
+        }
+      end
+
+      def spec_initializers
+        @spec_initializers ||= initializers.reduce({}) do |hash, name|
+          hash["spec/#{ name }.erb"] = "spec/support/initializers/#{ name }.rb"
+        end
+      end
+
       def initializers
-        %w(
-          caching coveralls database_cleaner factory_girl_rails
-          focus garbage_collection i18n migrations rails random_order rspec
-          timecop
+        @initializers ||= %w(
+          caching coveralls database_cleaner factory_girl_rails focus
+          garbage_collection i18n migrations rails random_order rspec timecop
         )
       end
 
-      def matchers
-        %w(controllers json_schema)
+      def matchers_files
+        @matchers_files ||= begin
+          from, to = "matchers/", "spec/support/matchers/"
+          {
+            "#{ from }controllers.erb" => "#{ to }controllers.rb",
+            "#{ from }json_schema.erb" => "#{ to }json_schema.rb"
+          }
+        end
+      end
+
+      def settings_files
+        @settings_files ||= {
+          "root/coveralls.erb" => ".coveralls.yml",
+          "root/rspec.erb"     => ".rspec",
+          "root/rubocop.erb"   => ".rubocop.yml",
+          "root/travis.erb"    => ".travis.yml",
+          "root/Rakefile.erb"  => "Rakefile",
+          "root/Guardfile.erb" => "Guardfile"
+        }
+      end
+
+      def root_files
+        @root_files ||= {
+          "root/gitignore.erb" => ".gitignore",
+          "root/LICENSE.erb"   => "LICENSE.rdoc",
+          "root/README.erb"    => "README.rdoc",
+          "root/Gemfile.erb"   => "Gemfile",
+          "root/gemspec.erb"   => "#{ gem_name }.gemspec"
+        }
+      end
+
+      def json_files
+        @json_files ||= begin
+          from, to = "json_schemas/", "spec/requests/json_schemas/"
+          {
+            "#{ from }get_errors.erb" => "#{ to }get_errors.json",
+            "#{ from }error.erb"      => "#{ to }shared/error.json",
+            "#{ from }success.erb"    => "#{ to }shared/success.json"
+          }
+        end
       end
     end
   end

data/lib/generators/install/templates/{spec → matchers}/json_schema.erb

@@ -5,6 +5,6 @@ RSpec::Matchers.define :match_json_schema do |schema|
   match do |response|
     schema_directory = "#{Dir.pwd}/spec/requests/json_schemas"
     schema_path = "#{schema_directory}/#{schema}.json"
-    JSON::Validator.validate!(schema_path, response, strict: true)
+    JSON::Validator.validate! schema_path, response
   end
 end

data/lib/generators/request/templates/request_spec.erb

@@ -28,7 +28,7 @@ module <%= module_name %>
     #   before { call_request params }
 
     #   it "changes something" do
-    #     expect (something).to eq something
+    #     expect(something).to eq something
     #   end
 
     #   it "responds with 200" do
@@ -51,7 +51,7 @@ module <%= module_name %>
     #   before { call_request params }
 
     #   it "doesn't change something" do
-    #     expect (something).to eq something
+    #     expect(something).to eq something
     #   end
 
     #   it "responds with 400" do

data/lib/generators/use_case/templates/use_case.erb

@@ -1,6 +1,21 @@
 module <%= module_name %>
 
-  # TODO: add a description
+  # TODO: What does the case do?
+  #
+  # @example
+  #     use_case = <%= class_name %>.new(TODO: TODO)
+  #     use_case.subscribe some_listener
+  #     use_case.run
+  #
+  # Methods:
+  # <tt>.new</tt>:: initializes a use case with some uuid.
+  # <tt>#subscribe</tt>:: subscribes listeners for <tt>#run</tt>'s notifications
+  # <tt>#run</tt>:: runs a case and returns TODO or +nil+
+  # <tt>#run!</tt>:: runs a case. Fails if no firm found.
+  #
+  # The +run+ method returns TODO (or +nil+) and notifies its listeners:
+  # <tt>:TODO</tt>:: when TODO.
+  #
   class <%= class_name %> < Hexx::UseCase
 
     # Allow necessary parameters here:
@@ -9,6 +24,15 @@ module <%= module_name %>
     # Add case-specific validations
     # validates :some_attribute, presence: true
 
+    # Runs the case and fails if TODO.
+    #
+    # @example
+    #     <%= class_name %>.new(TODO: TODO).run!
+    #     # => #<<%= module_name %>::TODO ...>
+    #
+    #     <%= class_name %>.new.run!
+    #     # => fails with #<TODO ...>
+    #
     def run!
       validate!
       # describe other rules here

data/lib/generators/use_case/templates/use_case_spec.erb

@@ -13,7 +13,7 @@ module <%= module_name %>
     # Prepare variables
     # ==========================================================================
 
-    # let!(:params)  { { key: value } }
+    # let!(:params)  { { "key" => value } }
     # let(:listener) { double "listener" }
 
     # def prepare_case(params)
@@ -28,7 +28,7 @@ module <%= module_name %>
 
     describe "#run" do
 
-      # context "with proper params" do
+      # context "with valid params" do
 
       #   subject(:use_case) { prepare_case params }
 
@@ -49,7 +49,7 @@ module <%= module_name %>
       #   end
       # end
 
-      # context "with improper params" do
+      # context "with invalid params" do
 
       #   before { params[:something] = something }
       #   subject(:use_case) { prepare_case params }

data/lib/hexx/version.rb

@@ -2,5 +2,5 @@
 module Hexx
 
   # Current release.
-  VERSION = "1.1.0"
+  VERSION = "1.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hexx
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Andrew Kozin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-23 00:00:00.000000000 Z
+date: 2014-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -174,17 +174,8 @@ files:
 - lib/generators/domain/domain.rb
 - lib/generators/domain/templates/spec.erb
 - lib/generators/install/install.rb
-- lib/generators/install/templates/CHANGELOG.erb
-- lib/generators/install/templates/Gemfile.erb
-- lib/generators/install/templates/Guardfile.erb
-- lib/generators/install/templates/LICENSE.erb
-- lib/generators/install/templates/README.erb
-- lib/generators/install/templates/Rakefile.erb
 - lib/generators/install/templates/bin/rails.erb
 - lib/generators/install/templates/config/routes.erb
-- lib/generators/install/templates/coveralls.erb
-- lib/generators/install/templates/gemspec.erb
-- lib/generators/install/templates/gitignore.erb
 - lib/generators/install/templates/json_schemas/error.erb
 - lib/generators/install/templates/json_schemas/get_errors.erb
 - lib/generators/install/templates/json_schemas/success.erb
@@ -192,24 +183,32 @@ files:
 - lib/generators/install/templates/lib/lib.erb
 - lib/generators/install/templates/lib/task.erb
 - lib/generators/install/templates/lib/version.erb
-- lib/generators/install/templates/rspec.erb
-- lib/generators/install/templates/rubocop.erb
+- lib/generators/install/templates/matchers/controllers.erb
+- lib/generators/install/templates/matchers/json_schema.erb
+- lib/generators/install/templates/root/Gemfile.erb
+- lib/generators/install/templates/root/Guardfile.erb
+- lib/generators/install/templates/root/LICENSE.erb
+- lib/generators/install/templates/root/README.erb
+- lib/generators/install/templates/root/Rakefile.erb
+- lib/generators/install/templates/root/coveralls.erb
+- lib/generators/install/templates/root/gemspec.erb
+- lib/generators/install/templates/root/gitignore.erb
+- lib/generators/install/templates/root/rspec.erb
+- lib/generators/install/templates/root/rubocop.erb
+- lib/generators/install/templates/root/travis.erb
 - lib/generators/install/templates/spec/caching.erb
-- lib/generators/install/templates/spec/controllers.erb
 - lib/generators/install/templates/spec/coveralls.erb
 - lib/generators/install/templates/spec/database_cleaner.erb
 - lib/generators/install/templates/spec/factory_girl_rails.erb
 - lib/generators/install/templates/spec/focus.erb
 - lib/generators/install/templates/spec/garbage_collection.erb
 - lib/generators/install/templates/spec/i18n.erb
-- lib/generators/install/templates/spec/json_schema.erb
 - lib/generators/install/templates/spec/migrations.erb
 - lib/generators/install/templates/spec/rails.erb
 - lib/generators/install/templates/spec/random_order.erb
 - lib/generators/install/templates/spec/rspec.erb
 - lib/generators/install/templates/spec/spec_helper.erb
 - lib/generators/install/templates/spec/timecop.erb
-- lib/generators/install/templates/travis.erb
 - lib/generators/request/request.rb
 - lib/generators/request/templates/request_spec.erb
 - lib/generators/use_case/templates/use_case.erb

data/lib/generators/install/templates/CHANGELOG.erb

@@ -1,13 +0,0 @@
-= CHANGELOG
-
-== <%= Time.now.strftime("%Y-%m-%d") %> 0.0.1-alpha
-
-=== Added
-
-=== Deleted
-
-=== Fixed
-
-=== Deprecated
-
-=== Security