hexx 1.1.1 → 2.0.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hexx
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Andrew Kozin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-25 00:00:00.000000000 Z
+date: 2014-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -24,20 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.1'
-- !ruby/object:Gem::Dependency
-  name: extlib
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: wisper
   requirement: !ruby/object:Gem::Requirement
@@ -136,108 +122,40 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.11'
-description: Hexx::UseCase class with some generators for decoupling domain from a
-  Rails controllers.
+description: Defines domain service object and model attributes coercion.
 email: andrew.kozin@gmail.com
-executables:
-- hexx
+executables: []
 extensions: []
 extra_rdoc_files:
-- CHANGELOG.rdoc
 - LICENSE.rdoc
 - README.rdoc
 files:
 - ".rubocop.yml"
-- CHANGELOG.rdoc
 - LICENSE.rdoc
 - README.rdoc
 - Rakefile
-- bin/hexx
-- lib/generators/base.rb
-- lib/generators/controller/controller.rb
-- 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_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
-- lib/generators/dependency/templates/initializer.erb
-- lib/generators/dependency/templates/initializer_setting.erb
-- lib/generators/dependency/templates/module_spec.erb
-- lib/generators/domain/domain.rb
-- lib/generators/domain/templates/spec.erb
-- lib/generators/install/install.rb
-- lib/generators/install/templates/bin/rails.erb
-- lib/generators/install/templates/config/routes.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/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/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/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/request/request.rb
-- lib/generators/request/templates/request_spec.erb
-- lib/generators/use_case/templates/use_case.erb
-- lib/generators/use_case/templates/use_case_spec.erb
-- lib/generators/use_case/use_case.rb
 - lib/hexx.rb
-- lib/hexx/exceptions/not_found_error.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
+- lib/hexx/models/base_coercer.rb
+- lib/hexx/service.rb
+- lib/hexx/service/invalid.rb
+- lib/hexx/service/message.rb
+- lib/hexx/service/messages.rb
+- lib/hexx/service/parameters.rb
+- lib/hexx/service/transactions.rb
+- lib/hexx/service/validations.rb
 - lib/hexx/version.rb
-- spec/hexx/exceptions/not_found_error_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
+- spec/hexx/service/invalid_spec.rb
+- spec/hexx/service/message_spec.rb
+- spec/hexx/service_spec.rb
+- spec/initializers/coveralls.rb
+- spec/initializers/focus.rb
+- spec/initializers/garbage_collection.rb
+- spec/initializers/i18n.rb
+- spec/initializers/random_order.rb
+- spec/initializers/rspec.rb
 - spec/spec_helper.rb
-- spec/support/exception_matchers.rb
-- spec/support/initializers/coveralls.rb
-- spec/support/initializers/focus.rb
-- spec/support/initializers/garbage_collection.rb
-- spec/support/initializers/i18n.rb
-- spec/support/initializers/random_order.rb
-- spec/support/initializers/rspec.rb
 homepage: https://github.com/nepalez/hexx
 licenses:
 - MIT
@@ -261,23 +179,19 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: UseCase part of a Hexx framework.
+summary: Service objects for Rails.
 test_files:
 - spec/spec_helper.rb
-- spec/hexx/message_spec.rb
-- spec/hexx/settings_spec.rb
-- spec/hexx/exceptions/not_found_error_spec.rb
-- spec/hexx/exceptions/use_case_invalid_spec.rb
-- spec/hexx/exceptions/runtime_error_spec.rb
+- spec/hexx/service_spec.rb
+- spec/hexx/service/message_spec.rb
+- spec/hexx/service/invalid_spec.rb
 - spec/hexx/models_spec.rb
-- spec/hexx/use_case_spec.rb
-- spec/support/exception_matchers.rb
-- spec/support/initializers/garbage_collection.rb
-- spec/support/initializers/i18n.rb
-- spec/support/initializers/focus.rb
-- spec/support/initializers/coveralls.rb
-- spec/support/initializers/random_order.rb
-- spec/support/initializers/rspec.rb
+- spec/initializers/garbage_collection.rb
+- spec/initializers/i18n.rb
+- spec/initializers/focus.rb
+- spec/initializers/coveralls.rb
+- spec/initializers/random_order.rb
+- spec/initializers/rspec.rb
 - Rakefile
 - ".rubocop.yml"
 has_rdoc: 

data/CHANGELOG.rdoc

@@ -1,12 +0,0 @@
-= 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/bin/hexx

@@ -1,54 +0,0 @@
-#!/usr/bin/env ruby
-require "thor"
-require "rubygems"
-
-root = File.dirname File.dirname(__FILE__)
-Dir[File.join(root, "lib/generators/**/*.rb")].each { |file| require file }
-
-# Scaffold tasks for the Hexx based projects.
-class HexxRunner < Thor
-
-  desc "install", "scaffolds a new project"
-  def install
-    script = Hexx::Generators::Install.new [project]
-    script.invoke_all
-  end
-
-  desc "request", "scaffolds a new request spec (acceptance test)"
-  def request(name)
-    script = Hexx::Generators::Request.new [project, name]
-    script.invoke_all
-  end
-
-  desc "controller", "scaffolds a new route with a controller action"
-  def controller(name, route, usecase)
-    script = Hexx::Generators::Controller.new [project, name, route, usecase]
-    script.invoke_all
-  end
-
-  desc "domain", "scaffolds a new acceptance test for the domain"
-  def domain(name)
-    script = Hexx::Generators::Domain.new [project, name]
-    script.invoke_all
-  end
-
-  desc "use_case", "scaffolds a new use case"
-  def use_case(name)
-    script = Hexx::Generators::UseCase.new [project, name]
-    script.invoke_all
-  end
-
-  desc "depencency", "scaffolds a dependency"
-  def dependency(name)
-    script = Hexx::Generators::Dependency.new [project, name]
-    script.invoke_all
-  end
-
-  private
-
-  def project
-    Dir.getwd.split("/").last.to_s.downcase
-  end
-end
-
-HexxRunner.start

data/lib/generators/base.rb

@@ -1,59 +0,0 @@
-require "thor"
-require "extlib"
-
-module Hexx
-  module Generators
-
-    # Base class for scaffolders.
-    class Base < Thor::Group
-      include Thor::Actions
-
-      argument :project
-      argument :name
-
-      def self.source_root(file = __FILE__)
-        root = File.dirname File.expand_path(file)
-        @source_root ||= File.join(root, "templates")
-      end
-
-      private
-
-      def gem_name
-        @gem_name ||= project.snake_case
-      end
-
-      def module_name
-        @module_name ||= project.camel_case
-      end
-
-      def class_name
-        @class_name ||= name.camel_case
-      end
-
-      def file_name
-        @file_name ||= name.snake_case
-      end
-
-      def action_type(string)
-        return @action_type if @action_type
-        list = string.split(":")
-        list.count > 1 ? list.first.downcase : "get"
-      end
-
-      def action_name(string)
-        string.split(":").last.downcase
-      end
-
-      def inject_template_into_file(source, file, options)
-        source  = File.expand_path(find_in_source_paths(source.to_s))
-        context = instance_eval("binding")
-        content = ERB.new(::File.binread(source), nil, "-", "@output_buffer")
-          .result(context)
-
-        inject_into_file file, options do
-          content
-        end
-      end
-    end
-  end
-end

data/lib/generators/controller/controller.rb

@@ -1,114 +0,0 @@
-require_relative "../base"
-
-module Hexx
-  module Generators
-
-    # Scaffolds rails controller action and a corresponding route spec.
-    class Controller < Base
-
-      argument :route
-      argument :usecase
-
-      def self.source_root
-        super __FILE__
-      end
-
-      def create_routing_spec
-        template(
-          "routing_spec.erb",
-          "spec/routing/#{api_path}/#{file_name}_routing_spec.rb",
-          skip: true
-        )
-      end
-
-      def add_route_spec
-        inject_template_into_file(
-          "routing_action_spec.erb",
-          "spec/routing/#{api_path}/#{file_name}_routing_spec.rb",
-          before: "  end\nend"
-        )
-      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",
-          "spec/controllers/#{api_path}/#{file_name}_controller_spec.rb",
-          skip: true
-        )
-      end
-
-      def add_controller_action_spec
-        inject_template_into_file(
-          "controller_action_spec.erb",
-          "spec/controllers/#{api_path}/#{file_name}_controller_spec.rb",
-          before: "\n      end"
-        )
-      end
-
-      def create_controller
-        template(
-          "controller.erb",
-          "app/controllers/#{api_path}/#{file_name}_controller.rb",
-          skip: true
-        )
-      end
-
-      def add_controller_action
-        inject_template_into_file(
-          "controller_action.erb",
-          "app/controllers/#{api_path}/#{file_name}_controller.rb",
-          before: "\n      end"
-        )
-      end
-
-      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
-
-      def action_type
-        @action_type ||= super route
-      end
-
-      def action_name
-        @action_name ||= super route
-      end
-
-      def use_case
-        @use_case ||= usecase.camel_case
-      end
-
-      def use_case_file
-        @use_case_file ||= usecase.snake_case
-      end
-
-      def api_path
-        "#{ gem_name }/api/v1"
-      end
-    end
-  end
-end

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

@@ -1,10 +0,0 @@
-module <%= module_name %>
-  module Api
-    module V1
-
-      # TODO: add a description
-      class <%= class_name %>Controller < ResponderController
-      end
-    end
-  end
-end

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

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

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

@@ -1,21 +0,0 @@
-
-        # describe "#<%= action_name %>" do
-
-        #   let!(:params) { { "something" => "something", "wrong" => "wrong" } }
-
-        #   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 "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

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

@@ -1,20 +0,0 @@
-require "spec_helper"
-
-module <%= module_name %>
-  module Api
-    module V1
-      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" }
-
-        # before do
-        #   allow(use_case).to receive(:subscribe)
-        #   allow(use_case).to receive(:run) { controller.render inline: "" }
-        # end
-      end
-    end
-  end
-end

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

@@ -1,40 +0,0 @@
-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

@@ -1,65 +0,0 @@
-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/routing_action_spec.erb

@@ -1,13 +0,0 @@
-
-    # describe "#<%= action_name %>" do
-
-    #   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

@@ -1,11 +0,0 @@
-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 %>" }
-  end
-end

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

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

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

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