hexx 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e785de1749dfa0413059159c18f56b3249f057cf
-  data.tar.gz: 3d29b3bdcc0a0af55f7915a034872a35bd128409
+  metadata.gz: 328ff58d93538e10c8f80618deaf8c4e640f8ecf
+  data.tar.gz: 6b3957ae87b7f0dd01da5f5213acf9567df9e076
 SHA512:
-  metadata.gz: b3bb5ed74006254480995a7a7eb1a1f44c586d19dc3aadfa3d632556ff14e90098de4ea192b282550d109e3f43a0266a61918b4f9f068cd96658d8b2634c136f
-  data.tar.gz: 43298906942eaf319ad0a25d9bdb7a466dc22d0dcc45d68780cf4505213da94d70d1a9d67d47fe0aeef9a3a3b7bce9ed501b02b8a81580a8865fcdbf0d7e2332
+  metadata.gz: 24bedd30a43978ea114d5acff719bdb8416ff1ba0cdacfe75ca722163d67e4560dcfab4841a2965227626f182c15c4d0973a33efb87678bd35eb74e29772c0ba
+  data.tar.gz: 194270afa308dfdae9648aec04055b8ae99d539fc203df8efe83cd000662cc86a631cf353a73b03c93de9c3fb447c0d3881d0712495e6f50b89bfa289b8951c3

data/lib/generators/controller/controller.rb

@@ -45,10 +45,10 @@ module Hexx
         )
       end
 
-      def create_application_controller
+      def create_responder
         template(
-          "application_controller.erb",
-          "app/controllers/#{api_path}/application_controller.rb",
+          "responder.erb",
+          "app/controllers/#{api_path}/responder.rb",
           skip: true
         )
       end
@@ -65,7 +65,7 @@ module Hexx
         inject_template_into_file(
           "controller_action.erb",
           "app/controllers/#{api_path}/#{file_name}_controller.rb",
-          after: " < ApplicationController"
+          after: " < Responder"
         )
       end
 

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

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

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

@@ -7,15 +7,16 @@
           #   before { allow(<%= use_case %>).to receive(:new).and_return(use_case) }
           #   after  { <%= action_type %> :<%= action_name %>, params }
 
-          #   it "provides a use case with proper parameters" do
-          #     expect(<%= use_case %>).to receive(:new).with(params.slice("something"))
+          #   it "sets use case with proper parameters" do
+          #     expect(<%= use_case %>).to receive(:new)
+          #       .with params.slice("something")
           #   end
 
-          #   it "listens to use case" do
+          #   it "listens to the case" do
           #     expect(controller).to listen_to use_case
           #   end
 
-          #   it "runs the case after subscribtion" do
-          #     expect(use_case).to run_after_subscription
+          #   it "runs the case after subscribtions" do
+          #     expect(use_case).to run_after_subscriptions
           #   end
           # end

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

@@ -1,5 +1,4 @@
 require "spec_helper"
-require "support/matchers/controllers"
 
 module <%= module_name %>
   module Api
@@ -12,8 +11,8 @@ module <%= module_name %>
         # let(:use_case) { double "use_case" }
 
         # before do
-        #   allow(use_case).to receive(:run) { controller.render inline: "" }
         #   allow(use_case).to receive(:subscribe)
+        #   allow(use_case).to receive(:run) { controller.render inline: "" }
         # end
 
         describe "action" do
@@ -30,12 +29,12 @@ module <%= module_name %>
           #     expect(assigns(:messages)).to eq :messages
           #   end
 
-          #   it "renders a proper template" do
+          #   it "renders 'error'" do
           #     expect(response)
           #       .to render_template "<%= gem_name %>/api/v1/shared/error"
           #   end
 
-          #   it "returns status 400" do
+          #   it "responds with 400" do
           #     expect(response.status).to eq 400
           #   end
           # end
@@ -49,12 +48,12 @@ module <%= module_name %>
           #     expect(assigns(:messages)).to eq :messages
           #   end
 
-          #   it "renders a proper template" do
+          #   it "renders 'error'" do
           #     expect(response)
           #       .to render_template "<%= gem_name %>/api/v1/shared/error"
           #   end
 
-          #   it "returns status 404" do
+          #   it "responds with 404" do
           #     expect(response.status).to eq 404
           #   end
           # end

data/lib/generators/controller/templates/{application_controller.erb → responder.erb}

@@ -2,9 +2,8 @@ module <%= module_name %>
   module Api
     module V1
 
-      # Base controller for the API
-      # Collects standard method for responding to users.
-      class ApplicationController < ::ApplicationController
+      # Responds to the client depending of use case result.
+      class Responder < ::ApplicationController
 
         # def on_error(messages, status: 400)
         #   @messages = messages

data/lib/generators/install/install.rb

@@ -68,7 +68,7 @@ module Hexx
       end
 
       def add_json_schemas_path
-        run "mkdir spec/json_schemas"
+        run "mkdir spec/examples/json_schemas"
       end
 
       def add_services
@@ -115,7 +115,7 @@ module Hexx
 
       def initializers
         %w(
-          caching coveralls database_cleaner factory_girl factory_girl_rails
+          caching coveralls database_cleaner factory_girl_rails
           focus garbage_collection i18n migrations rails random_order rspec
           timecop
         )

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

@@ -30,6 +30,7 @@ require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new :spec
 task :default do
+  sh "bundle exec rake db:migrate RAILS_ENV=test"
   sh "bundle exec rspec spec"
 end
 

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

@@ -24,7 +24,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency "database_cleaner"
   s.add_development_dependency "factory_girl_rails"
   s.add_development_dependency "inch"
-  s.add_development_dependency "json_schema"
+  s.add_development_dependency "json-schema"
   s.add_development_dependency "metric_fu"
   s.add_development_dependency "rspec-rails"
   s.add_development_dependency "rubocop"

data/lib/generators/install/templates/spec/{json_shema.erb → 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/json_schemas"
+    schema_directory = "#{Dir.pwd}/spec/support/examples/json_schemas"
     schema_path = "#{schema_directory}/#{schema}.json"
     JSON::Validator.validate!(schema_path, response, strict: true)
   end

data/lib/generators/request/request.rb

@@ -31,12 +31,12 @@ module Hexx
 
       # full_path: "items/{id}"
       def full_name
-        @full_name ||= parts[1]
+        @full_name ||= parts[1].to_s
       end
 
       # type of action: "get"
       def action_type
-        @action_type ||= parts[0]
+        @action_type ||= parts[0].to_s
       end
 
       # path from the request: get:items/{id} => ["get", "items/{id}"]

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

@@ -1,76 +1,65 @@
 require "spec_helper"
-require "support/matchers/requests"
 
 module <%= module_name %>
   describe "<%= action_type.upcase %> api/v1/<%= full_name %>" do
 
     # ==========================================================================
-    # Prepare environment
+    # Prepare context
     # ==========================================================================
 
-    # before { Timecop.freeze }
-    # after  { Timecop.return }
-
     # let!(:something) { something }
 
     # ==========================================================================
     # Prepare variables
     # ==========================================================================
 
-    # let!(:params) { { something: something } }
+    # let!(:params) { { "something" => something } }
 
     # def call_request(params)
     #   <%= action_type %> "<%= gem_name %>/api/v1/<%= escaped_name %>", params
     # end
 
-    # let!(:expected_data) do
-    #   {
-    #     something: something
-    #   }
-    # end
-
-    # def check_data(id)
-    #   get "<%= gem_name %>/api/v1/<%= escaped_name %>"
-    #   JSON.parse(response.body)["data"]
-    # end
-
     # ==========================================================================
     # Run tests
     # ==========================================================================
 
     # context "with proper params" do
 
-    #   before     { call_request params }
-    #   let(:json) { JSON.parse(response.body) }
+    #   before { call_request params }
 
-    #   it "receives http response 200" do
+    #   it "changes something" do
+    #     expect (something).to eq something
+    #   end
+
+    #   it "responds with 200" do
     #     expect(response.status).to eq 200
     #   end
 
-    #   it "receives a proper json response" do
-    #     expect(json["success"]).to eq true
-    #     expect(json["messages"]).not_to be_blank
-    #     expect(json["data"]).to eq check_data(id)
+    #   it "receives proper json" do
+    #     expect(response.body).to match_json_schema(:something)
     #   end
 
-    #   it "changes something" do
-    #     data = check_data(id)
-    #     expect(data["something"]).to eq params[:something]
+    #   it "receives something" do
+    #     something = JSON.parse(response.body)["something"]
+    #     expect(something).to eq something
     #   end
     # end
 
-    # context "with improper params" do
+    # context "with wrong params" do
     #
-    #   before     { params[:something] = something }
-    #   before     { call_request params }
+    #   before { params["something"] = something }
+    #   before { call_request params }
+
+    #   it "doesn't change something" do
+    #     expect (something).to eq something
+    #   end
 
-    #   it "reports error 400" do
-    #     expect(response).to report_error 400
+    #   it "responds with 400" do
+    #     expect(response.status).to eq 400
     #   end
 
-    #   it "doesn't change something" do
-    #     data = check_data(id)
-    #     expect(data["something"]).not_to eq params[:something]
+    #   it "receives proper json" do
+    #     expect(response.body).to match_json_schema(:get_errors)
     #   end
     # end
   end

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

@@ -4,7 +4,7 @@ module <%= module_name %>
   describe <%= class_name %> do
 
     # ==========================================================================
-    # Prepare environment
+    # Prepare context
     # ==========================================================================
 
     # let!(:something) { create :something }
@@ -13,9 +13,8 @@ module <%= module_name %>
     # Prepare variables
     # ==========================================================================
 
-    # let!(:params)          { { key: value } }
-    # let!(:expected_result) { something }
-    # let(:listener)         { double "listener" }
+    # let!(:params)  { { key: value } }
+    # let(:listener) { double "listener" }
 
     # def prepare_case(params)
     #   use_case = <%= class_name %>.new params
@@ -34,8 +33,7 @@ module <%= module_name %>
       #   subject(:use_case) { prepare_case params }
 
       #   it "does something" do
-      #     expect { use_case.run }.to change { something }
-      #       .from(something).to(something)
+      #     expect { use_case.run }.to change { something }.to(something)
       #   end
 
       #   it "returns something" do
@@ -58,7 +56,6 @@ module <%= module_name %>
 
       #   it "doesn't do something" do
       #     expect { use_case.run }.not_to change { something }
-      #       .from something
       #   end
 
       #   it "returns nil" do

data/lib/hexx/message.rb

@@ -0,0 +1,20 @@
+module Hexx
+
+  # A message to be returned by use_case
+  class Message
+
+    attr_reader :type, :text
+
+    def initialize(type:, text:)
+      @type, @text = type.to_s, text.to_s
+    end
+
+    def type=(value)
+      @type = value.to_s
+    end
+
+    def text=(value)
+      @text = value.to_s
+    end
+  end
+end

data/lib/hexx/use_case.rb

@@ -220,7 +220,7 @@ module Hexx
     # notifications to listeners.
     #
     # Expected to be called from a controller action.
-    # 
+    #
     def run
       run!
     rescue Hexx::NotFoundError => error
@@ -242,8 +242,8 @@ module Hexx
       fail UseCaseInvalid.new(self)
     end
 
-    def finish_with(name, arg)
-      publish name, arg
+    def finish_with(name, errors)
+      publish name, errors.map { |text| Message.new type: :error, text: text }
       nil
     end
 

data/lib/hexx/version.rb

@@ -1,4 +1,4 @@
 # Core classes to follow hexagonal domain architecture.
 module Hexx
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/spec/hexx/message_spec.rb

@@ -0,0 +1,31 @@
+module Hexx
+  describe Message do
+
+    let!(:message) { Message.new type: "info", text: "" }
+
+    describe ".new" do
+
+      it "requires type" do
+        expect { Message.new text: "" }.to raise_error
+      end
+
+      it "requires text" do
+        expect { Message.new type: "" }.to raise_error
+      end
+    end
+
+    describe "#type=" do
+
+      it "sets the type" do
+        expect { message.type = :error }.to change { message.type }.to "error"
+      end
+    end
+
+    describe "#text=" do
+
+      it "sets the text" do
+        expect { message.text = "Text" }.to change { message.text }.to "Text"
+      end
+    end
+  end
+end

data/spec/hexx/use_case_spec.rb

@@ -166,7 +166,8 @@ module Hexx
 
         it "publishes the :not_found notification" do
           expect(listener).to receive(:not_found) do |messages|
-            expect(messages).to eq errors.values
+            expect(messages.map(&:type)).to eq ["error"]
+            expect(messages.map(&:text)).to eq ["invalid"]
           end
           use_case.run
         end
@@ -188,7 +189,8 @@ module Hexx
 
         it "publishes the :error notification" do
           expect(listener).to receive(:error) do |messages|
-            expect(messages).to eq errors.values
+            expect(messages.map(&:type)).to eq ["error"]
+            expect(messages.map(&:text)).to eq ["invalid"]
           end
           use_case.run
         end
@@ -209,8 +211,9 @@ module Hexx
         end
 
         it "publishes the :error notification" do
-          expect(listener).to receive(:error) do |arg|
-            expect(arg).to eq ["StandardError"]
+          expect(listener).to receive(:error) do |messages|
+            expect(messages.map(&:type)).to eq ["error"]
+            expect(messages.map(&:text)).to eq ["StandardError"]
           end
           use_case.run
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hexx
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Andrew Kozin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-28 00:00:00.000000000 Z
+date: 2014-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -155,11 +155,11 @@ files:
 - bin/hexx
 - lib/generators/base.rb
 - lib/generators/controller/controller.rb
-- lib/generators/controller/templates/application_controller.erb
 - lib/generators/controller/templates/controller.erb
 - 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/routing_action_spec.erb
 - lib/generators/controller/templates/routing_spec.erb
 - lib/generators/dependency/dependency.rb
@@ -191,12 +191,11 @@ files:
 - 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.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_shema.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
@@ -214,6 +213,7 @@ files:
 - lib/hexx/exceptions/record_invalid.rb
 - lib/hexx/exceptions/runtime_error.rb
 - lib/hexx/exceptions/use_case_invalid.rb
+- lib/hexx/message.rb
 - lib/hexx/models.rb
 - lib/hexx/settings.rb
 - lib/hexx/use_case.rb
@@ -222,6 +222,7 @@ files:
 - spec/hexx/exceptions/record_invalid_spec.rb
 - spec/hexx/exceptions/runtime_error_spec.rb
 - spec/hexx/exceptions/use_case_invalid_spec.rb
+- spec/hexx/message_spec.rb
 - spec/hexx/models_spec.rb
 - spec/hexx/settings_spec.rb
 - spec/hexx/use_case_spec.rb
@@ -259,6 +260,7 @@ specification_version: 4
 summary: UseCase part of a Hexx framework.
 test_files:
 - spec/spec_helper.rb
+- spec/hexx/message_spec.rb
 - spec/hexx/settings_spec.rb
 - spec/hexx/exceptions/record_invalid_spec.rb
 - spec/hexx/exceptions/not_found_error_spec.rb

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

@@ -1,6 +0,0 @@
-# Add factory girl syntax
-require "factory_girl"
-
-RSpec.configure do |config|
-  config.include FactoryGirl::Syntax::Methods
-end