hexx 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f14eb96fccf59e4cff2b528b7af4022bc1a06ba0
-  data.tar.gz: 129481aec498d829b4cfefa8826342d3c2656f52
+  metadata.gz: e785de1749dfa0413059159c18f56b3249f057cf
+  data.tar.gz: 3d29b3bdcc0a0af55f7915a034872a35bd128409
 SHA512:
-  metadata.gz: 33cda7123f07260c0c60b11e81d57fa2acdd15df6e3a918e21956f61564fbd76de750c263d82cdef7b324f757b369ab318ecc5137cf0220faf63d11d465c1da0
-  data.tar.gz: 2f9fc12483c459cde61bb5581a74e3c126f92722d741d323160af374eeefda52bec304735721f7bee9ca8989fc7b6aebe14bc868964f41c5b8617324f46db203
+  metadata.gz: b3bb5ed74006254480995a7a7eb1a1f44c586d19dc3aadfa3d632556ff14e90098de4ea192b282550d109e3f43a0266a61918b4f9f068cd96658d8b2634c136f
+  data.tar.gz: 43298906942eaf319ad0a25d9bdb7a466dc22d0dcc45d68780cf4505213da94d70d1a9d67d47fe0aeef9a3a3b7bce9ed501b02b8a81580a8865fcdbf0d7e2332

data/CHANGELOG.rdoc

@@ -1 +1,12 @@
-= CHANGELOG
+= CHANGELOG
+
+== 0.1.0 (28.09.2014)
+
+=== Changed features:
+
+* `install` generator refactored for usage of json_schema in requests specs:
+  - `json_schema` matchers added to support
+  - `request` matchers removed from support
+  - `controllers` matchers refactored
+
+* `controller` generator refactored

data/README.rdoc

@@ -1,5 +1,6 @@
 = Hexx
 
+{<img src="http://img.shields.io/gem/v/hexx.svg?style=flat" alt="Gem Version" />}[https://rubygems.org/gems/hexx]
 {<img src="http://img.shields.io/travis/nepalez/hexx.svg?style=flat" alt="Bild Status" />}[https://travis-ci.org/nepalez/hexx]
 {<img src="http://img.shields.io/codeclimate/github/nepalez/hexx.svg?style=flat" alt="Code Metrics" />}[https://codeclimate.com/github/nepalez/hexx]
 {<img src="http://img.shields.io/gemnasium/nepalez/hexx.svg?style=flat" alt="Dependency Status" />}[https://gemnasium.com/nepalez/hexx]
@@ -17,7 +18,15 @@ Provides:
 
 Add this line to your application's Gemfile:
 
-  gem 'hexx', git: "https://github.com/nepalez/hexx.git"
+    gem "hexx"
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hexx
 
 == Usage
 
@@ -69,7 +78,7 @@ In a typical case the controller should constist from:
           # An action (outer port) of the controller
           def show
             use_case = GetItem.new params.allow(:id)
-            # subscribes the controller for listening for the use case
+            # subscribes the controller for listening to the use case
             # notifications via the controller's inner ports.
             use_case.subscribe self
             use_case.run

data/Rakefile

@@ -29,3 +29,9 @@ RSpec::Core::RakeTask.new(:spec)
 task :default do
   sh "bundle exec rspec spec"
 end
+
+task full: [:default] do
+  sh "rubocop"
+  sh "metric_fu"
+  sh "inch"
+end

data/lib/generators/controller/controller.rb

@@ -16,7 +16,7 @@ module Hexx
       def create_routing_spec
         template(
           "routing_spec.erb",
-          "spec/routing/#{ api_path }/#{ file_name }_routing_spec.rb",
+          "spec/routing/#{api_path}/#{file_name}_routing_spec.rb",
           skip: true
         )
       end
@@ -24,7 +24,7 @@ module Hexx
       def add_route_spec
         inject_template_into_file(
           "routing_action_spec.erb",
-          "spec/routing/#{ api_path }/#{ file_name }_routing_spec.rb",
+          "spec/routing/#{api_path}/#{file_name}_routing_spec.rb",
           before: "  end\nend"
         )
       end
@@ -32,7 +32,7 @@ module Hexx
       def create_controller_spec
         template(
           "controller_spec.erb",
-          "spec/controllers/#{ api_path }/#{ file_name }_controller_spec.rb",
+          "spec/controllers/#{api_path}/#{file_name}_controller_spec.rb",
           skip: true
         )
       end
@@ -40,15 +40,23 @@ module Hexx
       def add_controller_action_spec
         inject_template_into_file(
           "controller_action_spec.erb",
-          "spec/controllers/#{ api_path }/#{ file_name }_controller_spec.rb",
+          "spec/controllers/#{api_path}/#{file_name}_controller_spec.rb",
           after: "describe \"action\" do"
         )
       end
 
+      def create_application_controller
+        template(
+          "application_controller.erb",
+          "app/controllers/#{api_path}/application_controller.rb",
+          skip: true
+        )
+      end
+
       def create_controller
         template(
           "controller.erb",
-          "app/controllers/#{ api_path }/#{ file_name }_controller.rb",
+          "app/controllers/#{api_path}/#{file_name}_controller.rb",
           skip: true
         )
       end
@@ -56,8 +64,22 @@ module Hexx
       def add_controller_action
         inject_template_into_file(
           "controller_action.erb",
-          "app/controllers/#{ api_path }/#{ file_name }_controller.rb",
-          after: " < ActionController"
+          "app/controllers/#{api_path}/#{file_name}_controller.rb",
+          after: " < ApplicationController"
+        )
+      end
+
+      def create_application_layout
+        create_file(
+          "app/views/layouts/#{api_path}/application.json.jbuilder",
+          skip: true
+        )
+      end
+
+      def create_view
+        create_file(
+          "app/views/#{api_path}/#{file_name}/#{action_name}.json.jbuilder",
+          skip: true
         )
       end
 

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

@@ -0,0 +1,24 @@
+module <%= module_name %>
+  module Api
+    module V1
+
+      # Base controller for the API
+      # Collects standard method for responding to users.
+      class ApplicationController < ::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

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

@@ -3,15 +3,11 @@ module <%= module_name %>
     module V1
 
       # TODO: add a description
-      controller <%= class_name %>Controller < ActionController
+      class <%= class_name %>Controller < ApplicationController
 
-        # def not_found(messages)
-        #   render json: { success: false, messages: messages }, status: 404
-        # end
-
-        # def error(messages)
-        #   render json: { success: false, messages: messages }, status: 422
-        # end
+        # ======================================================================
+        # Inner ports (to be called by use cases)
+        # ======================================================================
       end
     end
   end

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

@@ -1,8 +1,8 @@
 
-        
+
         # TODO: add a description
         # def <%= action_name %>
         #   use_case = <%= use_case %>.new params.permit(:something)
-        #   use_case.subscribe self
+        #   use_case.subscribe self, prefix: :on
         #   use_case.run
         # end

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

@@ -1,28 +1,21 @@
 
 
           # describe "#<%= action_name %>" do
-          #
-          #   let!(:params)         { { "something" => something } }
-          #   let!(:use_case_class) { <%= use_case %> }
-          #
-          #   before { allow(use_case_class).to receive(:new) { use_case } }
+
+          #   let!(:params) { { "something" => "something", "wrong" => "wrong" } }
+
+          #   before { allow(<%= use_case %>).to receive(:new).and_return(use_case) }
           #   after  { <%= action_type %> :<%= action_name %>, params }
-          #
-          #   it "initializes a proper use case with allowed parameters" do
-          #     expect(use_case_class).to receive(:new) do |options|
-          #       expect(options).to eq params.
-          #         slice %w(something)
-          #     end
+
+          #   it "provides a use case with proper parameters" do
+          #     expect(<%= use_case %>).to receive(:new).with(params.slice("something"))
           #   end
-          #
-          #   it "listens to use case notifications" do
-          #     expect(use_case).to receive(:subscribe) do |listener|
-          #       expect(listener).to eq controller
-          #     end
+
+          #   it "listens to use case" do
+          #     expect(controller).to listen_to use_case
           #   end
-          #
-          #   it "runs the case after all subscribtion" do
-          #     expect(use_case).to receive(:subscribe).exactly(1).times.order
-          #     expect(use_case).to receive(:run).order
+
+          #   it "runs the case after subscribtion" do
+          #     expect(use_case).to run_after_subscription
           #   end
           # end

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

@@ -1,48 +1,61 @@
 require "spec_helper"
+require "support/matchers/controllers"
 
 module <%= module_name %>
   module Api
     module V1
-      describe <%= class_name %>Controller
-        # Add this string if your project is a Rails Engine, not the Application
+      describe <%= class_name %>Controller do
+
+        # Add this line if your project is a Rails Engine, not the Application
         # routes { <%= module_name %>::Engine.routes }
 
-        # let!(:use_case) { double "use_case" }
+        # let(:use_case) { double "use_case" }
+
         # before do
-        #   allow(use_case).to receive(:run){ controller.render inline: "" }
+        #   allow(use_case).to receive(:run) { controller.render inline: "" }
+        #   allow(use_case).to receive(:subscribe)
         # end
 
         describe "action" do
         end
 
-        describe "listener" do
-
-          # let!(:messages) { ["message"] }
-          # let!(:item)     { { id: 1, name: "name" } }
-
-          # describe "#not_found" do
-          #
-          #   it "renders a correct json" do
-          #     expect(controller).to receive(:render) do |options|
-          #       expect(options[:json]).to eq {
-          #         something: something
-          #       }
-          #       expect(options[:status]).to eq 404
-          #     end
-          #     controller.not_found(messages)
+        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 a proper template" do
+          #     expect(response)
+          #       .to render_template "<%= gem_name %>/api/v1/shared/error"
+          #   end
+
+          #   it "returns status 400" do
+          #     expect(response.status).to eq 400
           #   end
           # end
 
-          # describe "#error" do
-          #
-          #   it "renders a correct json" do
-          #     expect(controller).to receive(:render) do |options|
-          #       expect(options[:json]).to eq {
-          #         something: something
-          #       }
-          #       expect(options[:status]).to eq 422
-          #     end
-          #     controller.error(messages)
+          # 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 a proper template" do
+          #     expect(response)
+          #       .to render_template "<%= gem_name %>/api/v1/shared/error"
+          #   end
+
+          #   it "returns status 404" do
+          #     expect(response.status).to eq 404
           #   end
           # end
         end

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

@@ -1,10 +1,13 @@
 
     # describe "#<%= action_name %>" do
-    #
-    #   let!(:action) {{ controller: "<%= gem_name %>/#{ root }", action: "<%= action_name %>" }}
-    #
-    #   it "is routable in a json format" do
-    #     action[:format] = "json"
-    #     expect(<%= action_type %>: "/#{ root }/something").to route_to action
+
+    #   let(:action) do
+    #     { controller: "<%= gem_name %>/#{ root }", action: "<%= action_name %>" }
+    #   end
+    
+    #   subject(:request) { { <%= action_type %>: "/#{ root }/something" } }
+
+    #   it "is routable in json" do
+    #     expect(request).to route_to action.merge(format: "json")
     #   end
     # end

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

@@ -2,9 +2,10 @@ require "spec_helper"
 
 module <%= module_name %>
   describe "<%= file_name %>" do
+
     # Add this line if your project is a Rails engine, not the application:
     # routes { <%= module_name %>::Engine.routes }
 
-    # let!(:root) { "api/v1/<%= file_name %>" }
+    # let(:root) { "api/v1/<%= file_name %>" }
   end
 end

data/lib/generators/dependency/dependency.rb

@@ -11,13 +11,13 @@ module Hexx
       end
 
       def add_spec
-        template "module_spec.erb", "spec/#{ gem_name }_spec.rb", skip: true
+        template "module_spec.erb", "spec/lib/#{ gem_name }_spec.rb", skip: true
       end
 
       def insert_setting_spec
         inject_template_into_file(
           "dependency_setting_spec.erb",
-          "spec/#{ gem_name }_spec.rb",
+          "spec/lib/#{ gem_name }_spec.rb",
           before: "\nend"
         )
       end
@@ -29,6 +29,22 @@ module Hexx
           before: "\nend"
         )
       end
+
+      def add_initializer
+        template(
+          "initializer.erb",
+          "spec/dummy/config/initializers/#{ gem_name }.rb",
+          skip: true
+        )
+      end
+
+      def insert_initializer_setting
+        inject_template_into_file(
+          "initializer_setting.erb",
+          "spec/dummy/config/initializers/#{ gem_name }.rb",
+          after: " do |config|"
+        )
+      end
     end
   end
 end

data/lib/generators/dependency/templates/dependency_setting_spec.erb

@@ -1,32 +1,37 @@
 
 
   # describe ".<%= file_name %>_name" do
-  #
+
   #   it "is public" do
   #     expect(subject).to respond_to(:<%= file_name %>_name).with(0).arguments
   #   end
   # end
 
   # describe ".<%= file_name %>" do
-  #
+
   #   it "is public" do
   #     expect(subject).to respond_to(:<%= file_name %>).with(0).arguments
   #   end
   # end
 
   # describe ".<%= file_name %>_name=" do
-  #
-  #   after { subject.<%= file_name %>_name = nil }
-  #
+
+  #   around do |example|
+  #     restore = subject.<%= file_name %>_name
+  #     subject.<%= file_name %>_name = nil
+  #     example.run
+  #     subject.<%= file_name %>_name = restore
+  #   end
+
   #   it "is public" do
   #     expect(subject).to respond_to(:<%= file_name %>_name=).with(1).argument
   #   end
-  #
+
   #   it "sets a <%= file_name %>_name" do
   #     expect { subject.<%= file_name %>_name = "TestClass" }
   #       .to change { subject.<%= file_name %>_name }.from(nil).to "TestClass"
   #   end
-  #
+
   #   it "sets a <%= file_name %>" do
   #     expect { subject.<%= file_name %>_name = "TestClass" }
   #       .to change { subject.<%= file_name %> }.from(nil).to TestClass