hexx 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: febc0a987a8672901a8caeaec404c683655389e1
-  data.tar.gz: 1b3ca68ec29fa8ed414710375ac82032fe4d03b1
+  metadata.gz: 5c91a43fe5d06b1d017e5361a82e3c6ea6fa6a82
+  data.tar.gz: 117f0a4bbe5433c6735d964fe1e180fda9b5a257
 SHA512:
-  metadata.gz: 618886945f8920eee3d647fe52580d286150557e211a54b19827f0cdd4bd02ef5c6593fd7d321b632482a4941f99ee8c5f33f7d31805e9a5260317e3a7ca95fd
-  data.tar.gz: 9ff2b732cacba20c559343f11f5e7f4dba3483c3631a9a1c53fc1974893ac49de0353701f558dec29b378757e76ad1d2d4f7cc68d214f8693af43c41b53d67fa
+  metadata.gz: 2e3dd4e4d761336d330861d7ec3e48a51941c5ae8400edc3f325d390deaee1549946b78e398287d1b0b2897a8bf2e1753f5bdf3afc890d57433fcf78c6d597ce
+  data.tar.gz: 72eedbc4ba915c1865096d77a195cbc4e96e912b57fad709cf47d3bc115cf47c00ab58e0e8a6f7a6e5deb07bceabfe835fa4f23686c54e0236e67dfd56a16691

data/lib/generators/controller/controller.rb

@@ -29,6 +29,22 @@ module Hexx
         )
       end
 
+      def create_responder_controller_spec
+        template(
+          "responder_controller_spec.erb",
+          "spec/controllers/#{api_path}/responder_controller_spec.rb",
+          skip: true
+        )
+      end
+
+      def create_responder_controller
+        template(
+          "responder_controller.erb",
+          "app/controllers/#{api_path}/responder_controller.rb",
+          skip: true
+        )
+      end
+
       def create_controller_spec
         template(
           "controller_spec.erb",
@@ -41,15 +57,7 @@ module Hexx
         inject_template_into_file(
           "controller_action_spec.erb",
           "spec/controllers/#{api_path}/#{file_name}_controller_spec.rb",
-          after: "describe \"action\" do"
-        )
-      end
-
-      def create_responder
-        template(
-          "responder.erb",
-          "app/controllers/#{api_path}/responder.rb",
-          skip: true
+          before: "\n      end"
         )
       end
 
@@ -65,22 +73,19 @@ module Hexx
         inject_template_into_file(
           "controller_action.erb",
           "app/controllers/#{api_path}/#{file_name}_controller.rb",
-          after: " < Responder"
-        )
-      end
-
-      def create_application_layout
-        create_file(
-          "app/views/layouts/#{api_path}/application.json.jbuilder",
-          skip: true
+          before: "\n      end"
         )
       end
 
-      def create_view
-        create_file(
-          "app/views/#{api_path}/#{file_name}/#{action_name}.json.jbuilder",
-          skip: true
+      def create_views
+        dir = "app/views/#{api_path}/#{file_name}"
+        run "mkdir #{dir} -p -v"
+        template "views_errors.erb", "#{ dir }/errors.json.jbuilder", skip: true
+        template(
+          "views_messages.erb", "#{ dir }/_messages.json.jbuilder", skip: true
         )
+        create_file "#{ dir }/#{action_name}.json.jbuilder", skip: true
+        create_file "#{ dir }/_#{class_name.downcase}.json.jbuilder", skip: true
       end
 
       private

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

@@ -3,11 +3,7 @@ module <%= module_name %>
     module V1
 
       # TODO: add a description
-      class <%= class_name %>Controller < Responder
-
-        # ======================================================================
-        # Inner ports (to be called by use cases)
-        # ======================================================================
+      class <%= class_name %>Controller < ResponderController
       end
     end
   end

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

@@ -1,5 +1,4 @@
 
-
         # TODO: add a description
         # def <%= action_name %>
         #   use_case = <%= use_case %>.new params.permit(:something)

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

@@ -1,22 +1,21 @@
 
+        # describe "#<%= action_name %>" do
 
-          # describe "#<%= action_name %>" do
+        #   let!(:params) { { "something" => "something", "wrong" => "wrong" } }
 
-          #   let!(:params) { { "something" => "something", "wrong" => "wrong" } }
+        #   before { allow(<%= use_case %>).to receive(:new).and_return(use_case) }
+        #   after  { <%= action_type %> :<%= action_name %>, params }
 
-          #   before { allow(<%= use_case %>).to receive(:new).and_return(use_case) }
-          #   after  { <%= action_type %> :<%= action_name %>, params }
+        #   it "sets use case with proper parameters" do
+        #     expect(<%= use_case %>).to receive(:new)
+        #       .with params.slice("something")
+        #   end
 
-          #   it "sets use case with proper parameters" do
-          #     expect(<%= use_case %>).to receive(:new)
-          #       .with params.slice("something")
-          #   end
+        #   it "listens to the case" do
+        #     expect(controller).to listen_to use_case
+        #   end
 
-          #   it "listens to the case" do
-          #     expect(controller).to listen_to use_case
-          #   end
-
-          #   it "runs the case after subscribtions" do
-          #     expect(use_case).to run_after_subscriptions
-          #   end
-          # end
+        #   it "runs the case after subscribtions" do
+        #     expect(use_case).to run_after_subscriptions
+        #   end
+        # end

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

@@ -14,50 +14,6 @@ module <%= module_name %>
         #   allow(use_case).to receive(:subscribe)
         #   allow(use_case).to receive(:run) { controller.render inline: "" }
         # end
-
-        describe "action" do
-        end
-
-        describe "responder" do
-
-          # describe "#on_error" do
-
-          #   controller(<%= class_name %>Controller) { def index; on_error :messages; end }
-          #   before { get :index, format: :json }
-
-          #   it "sets @messages" do
-          #     expect(assigns(:messages)).to eq :messages
-          #   end
-
-          #   it "renders 'error'" do
-          #     expect(response)
-          #       .to render_template "<%= gem_name %>/api/v1/shared/error"
-          #   end
-
-          #   it "responds with 400" do
-          #     expect(response.status).to eq 400
-          #   end
-          # end
-
-          # describe "#on_not_found" do
-
-          #   controller(<%= class_name %>Controller) { def index; on_not_found :messages; end }
-          #   before { get :index, format: :json }
-
-          #   it "sets @messages" do
-          #     expect(assigns(:messages)).to eq :messages
-          #   end
-
-          #   it "renders 'error'" do
-          #     expect(response)
-          #       .to render_template "<%= gem_name %>/api/v1/shared/error"
-          #   end
-
-          #   it "responds with 404" do
-          #     expect(response.status).to eq 404
-          #   end
-          # end
-        end
       end
     end
   end

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

@@ -0,0 +1,40 @@
+module <%= module_name %>
+
+  # Namespace for public JSON API.
+  module Api
+
+    # Namespace for API v.1
+    module V1
+
+      # Responds to the client depending of use case result.
+      class ResponderController < ApplicationController
+
+        # # Renders an error messages.
+        # #
+        # # Params:
+        # # +messages+:: a list of messages (<tt>Hexx::Message</tt> objects)
+        # #              to be shown to a client.
+        # #
+        # def on_error(messages, status: 400)
+        #   @messages = messages
+        #   render "error", status: status
+        # end
+
+        # # Renders an error messages and responds with 404 (Not found).
+        # #
+        # # Params:
+        # # +messages+:: a list of messages (<tt>Hexx::Message</tt> objects)
+        # #              to be shown to a client.
+        # #
+        # def on_not_found(messages)
+        #   on_error messages, status: 404
+        # end
+
+        # # Responds with 304 (Not changed).
+        # def on_not_changed
+        #   render status: 304
+        # end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+require "spec_helper"
+
+module <%= module_name %>
+  module Api
+    module V1
+      describe ResponderController do
+
+        # Add this line if your project is a Rails Engine, not the Application
+        # routes { <%= module_name %>::Engine.routes }
+
+        # describe "#on_not_changed" do
+
+        #   controller(<%= class_name %>Controller) do
+        #     def index; on_not_changed; end
+        #   end
+        #   before { get :index, format: :json }
+
+        #   it "responds with 304" do
+        #     expect(response.status).to eq 304
+        #   end
+        # end
+
+        # describe "#on_error" do
+
+        #   controller(<%= class_name %>Controller) do
+        #     def index; on_error :messages; end
+        #   end
+        #   before { get :index, format: :json }
+
+        #   it "sets @messages" do
+        #     expect(assigns(:messages)).to eq :messages
+        #   end
+
+        #   it "renders 'errors'" do
+        #     expect(response).to render_template "errors"
+        #   end
+
+        #   it "responds with 400" do
+        #     expect(response.status).to eq 400
+        #   end
+        # end
+
+        # describe "#on_not_found" do
+
+        #   controller(<%= class_name %>Controller) do
+        #     def index; on_not_found :messages; end
+        #   end
+        #   before { get :index, format: :json }
+
+        #   it "sets @messages" do
+        #     expect(assigns(:messages)).to eq :messages
+        #   end
+
+        #   it "renders 'errors'" do
+        #     expect(response).to render_template "errors"
+        #   end
+
+        #   it "responds with 404" do
+        #     expect(response.status).to eq 404
+        #   end
+        # end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,3 @@
+json.messages do |json|
+  json.partial! "messages", messages: @messages
+end

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

@@ -0,0 +1,3 @@
+json.array! @messages do |message|
+  json.extract! message, :type, :text
+end

data/lib/generators/install/install.rb

@@ -25,7 +25,7 @@ module Hexx
 
       def update_config
         template "config/routes.erb", "config/routes.rb", force: true
-        run "mkdir config/locales"
+        run "mkdir config/locales -p -v"
       end
 
       def update_lib
@@ -39,6 +39,11 @@ module Hexx
         end
       end
 
+      def add_tasks
+        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",
@@ -68,7 +73,25 @@ module Hexx
       end
 
       def add_json_schemas_path
-        run "mkdir spec/examples/json_schemas"
+        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
+        )
+      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
       end
 
       def add_services

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

@@ -29,16 +29,17 @@ require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new :spec
+
 task :default do
-  sh "mkdir spec/dummy/tmp/cache -p -v"
-  sh "bundle exec rake db:migrate RAILS_ENV=test"
-  sh "bundle exec rspec spec"
+  system "mkdir spec/dummy/tmp/cache -p -v"
+  system "bundle exec rake db:migrate RAILS_ENV=test"
+  system "bundle exec rspec spec"
 end
 
-task :full do
-  sh "coveralls report"
-  sh "rubocop"
-  sh "metric_fu"
-  sh "inch --pedantic"
-  sh "rails_best_practices"
+task :check do
+  system "coveralls report"
+  system "rubocop"
+  system "metric_fu"
+  system "inch --pedantic"
+  system "rails_best_practices"
 end

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

@@ -17,7 +17,7 @@ Gem::Specification.new do |s|
   s.test_files       = Dir["spec/**/*", "Rakefile", ".rubocop.yml"]
   s.extra_rdoc_files = Dir["CHANGELOG.rdoc", "LICENSE.rdoc", "README.rdoc"]
 
-  s.add_runtime_dependency "hexx"
+  s.add_runtime_dependency "hexx",    "~> 1.0.2"
   s.add_runtime_dependency "jbuilder"
   s.add_runtime_dependency "rails"
 

data/lib/generators/install/templates/json_schemas/error.erb

@@ -0,0 +1,14 @@
+// JSON schema for an error message
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+
+  "type": "object",
+
+  "properties": {
+    "type": { "type": "string", "enum": ["error"] },
+    "text": { "type": "string", "minLength": 1 }
+  },
+
+  "additionalProperties": false,
+  "required": ["type", "text"]
+}

data/lib/generators/install/templates/json_schemas/get_errors.erb

@@ -0,0 +1,18 @@
+// JSON schema for getting an error messages
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+
+  "type": "object",
+
+  "properties": {
+    "messages": {
+      "type": "array",
+      "items": { "$ref": "messages/error.json" },
+      "minimumUnits": 1,
+      "unique": true
+    }
+  },
+
+  "additionalProperties": false,
+  "required": ["messages"]
+}

data/lib/generators/install/templates/json_schemas/success.erb

@@ -0,0 +1,14 @@
+// JSON schema for an error message
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+
+  "type": "object",
+
+  "properties": {
+    "type": { "type": "string", "enum": ["success", "info"] },
+    "text": { "type": "string", "minLength": 1 }
+  },
+
+  "additionalProperties": false,
+  "required": ["type", "text"]
+}

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

@@ -0,0 +1,60 @@
+namespace :<%= gem_name %> do
+  namespace :install do
+
+    desc "Initializes the <%= gem_name %> gem to rails engine"
+    task default: %w(dependencies migrations routes)
+
+    desc "Installs the <%= gem_name %> gem dependencies"
+    task :dependencies do
+      reenable_railties
+      system "rake #{ app }uuids:install"
+    end
+
+    desc "Copies migrations from the <%= gem_name %> gem to application"
+    task :migrations do
+      reenable_railties
+      Rake::Task["#{ app }<%= gem_name %>:install:migrations"].invoke
+    end
+
+    desc "Mounts the <%= gem_name %> API routes"
+    task :routes do
+      insert_into_file(
+        "config/routes.rb",
+        before: "\nend",
+        line:   "\n\n  mount <%= module_name %>::Engine => \"/<%= gem_name %>\"",
+        engine: "<%= module_name %>::Engine"
+      ) unless engine?
+    end
+
+    def engine?
+      @engine ||= Rake::Task.task_defined?("railties:install:migrations")
+    end
+
+    def app
+      @app ||= engine? ? "" : "app:"
+    end
+
+    def reenable_railties
+      Rake::Task["#{ app }railties:install:migrations"].reenable
+    end
+
+    def insert_into_file(name, before:, line:, engine:)
+      say_with_time "mounting <%= gem_name %>' routes" do
+        text = File.read(name)
+        return if text[engine]
+        File.write name, text.gsub(before, line << before)
+      end
+    end
+
+    def say_with_time(text)
+      start = current_time
+      puts "=== #{ text } #{ "=" * (74 - text.count) }"
+      yield
+      puts "  -> #{ (current_time - start).round(4) }s"
+    end
+
+    def current_time
+      Time.new.to_f
+    end
+  end
+end

data/lib/generators/install/templates/spec/json_schema.erb

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

data/lib/hexx/version.rb

@@ -1,4 +1,6 @@
 # Core classes to follow hexagonal domain architecture.
 module Hexx
-  VERSION = "1.0.2"
+
+  # Current release.
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hexx
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Andrew Kozin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-21 00:00:00.000000000 Z
+date: 2014-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -159,9 +159,12 @@ files:
 - lib/generators/controller/templates/controller_action.erb
 - lib/generators/controller/templates/controller_action_spec.erb
 - lib/generators/controller/templates/controller_spec.erb
-- lib/generators/controller/templates/responder.erb
+- lib/generators/controller/templates/responder_controller.erb
+- lib/generators/controller/templates/responder_controller_spec.erb
 - lib/generators/controller/templates/routing_action_spec.erb
 - lib/generators/controller/templates/routing_spec.erb
+- lib/generators/controller/templates/views_errors.erb
+- lib/generators/controller/templates/views_messages.erb
 - lib/generators/dependency/dependency.rb
 - lib/generators/dependency/templates/dependency_setting.erb
 - lib/generators/dependency/templates/dependency_setting_spec.erb
@@ -182,8 +185,12 @@ files:
 - 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
 - lib/generators/install/templates/lib/engine.erb
 - 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

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

@@ -1,23 +0,0 @@
-module <%= module_name %>
-  module Api
-    module V1
-
-      # Responds to the client depending of use case result.
-      class Responder < ::ApplicationController
-
-        # def on_error(messages, status: 400)
-        #   @messages = messages
-        #   render template: "<%= gem_name %>/api/v1/shared/error", status: status
-        # end
-
-        # def on_not_found(messages)
-        #   on_error messages, status: 404
-        # end
-
-        # def on_not_changed
-        #   render status: 304
-        # end
-      end
-    end
-  end
-end