hexx 0.0.1

data/lib/generators/controller/controller.rb

@@ -0,0 +1,87 @@
+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_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",
+          after: "describe \"action\" do"
+        )
+      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",
+          after: " < ActionController"
+        )
+      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

@@ -0,0 +1,18 @@
+module <%= module_name %>
+  module Api
+    module V1
+
+      # TODO: add a description
+      controller <%= class_name %>Controller < ActionController
+
+        # 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
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,28 @@
+
+
+          # describe "#<%= action_name %>" do
+          #
+          #   let!(:params)         { { "something" => something } }
+          #   let!(:use_case_class) { <%= use_case %> }
+          #
+          #   before { allow(use_case_class).to receive(:new) { 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
+          #   end
+          #
+          #   it "listens to use case notifications" do
+          #     expect(use_case).to receive(:subscribe) do |listener|
+          #       expect(listener).to eq controller
+          #     end
+          #   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
+          #   end
+          # end

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

@@ -0,0 +1,52 @@
+require "spec_helper"
+
+module <%= module_name %>
+  module Api
+    module V1
+      describe <%= class_name %>Controller
+        # Add this string 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(:run){ controller.render inline: "" }
+        # 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)
+          #   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)
+          #   end
+          # end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+
+    # 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
+    #   end
+    # end

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

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

data/lib/generators/dependency/dependency.rb

@@ -0,0 +1,34 @@
+require_relative "../base"
+
+module Hexx
+  module Generators
+
+    # Project scaffolder
+    class Dependency < Base
+
+      def self.source_root
+        super __FILE__
+      end
+
+      def add_spec
+        template "module_spec.erb", "spec/#{ gem_name }_spec.rb", skip: true
+      end
+
+      def insert_setting_spec
+        inject_template_into_file(
+          "dependency_setting_spec.erb",
+          "spec/#{ gem_name }_spec.rb",
+          before: "\nend"
+        )
+      end
+
+      def insert_setting
+        inject_template_into_file(
+          "dependency_setting.erb",
+          "lib/#{ gem_name }.rb",
+          before: "\nend"
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,4 @@
+
+
+  # TODO: describe <%= file_name %>
+  depends_on :<%= file_name %>

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

@@ -0,0 +1,34 @@
+
+
+  # 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 }
+  #
+  #   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
+  #   end
+  # end

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

@@ -0,0 +1,22 @@
+require "spec_helper"
+
+describe <%= module_name %> do
+
+  before { class TestClass; end }
+  after  { Object.send :remove_const, :TestClass }
+
+  let!(:subject) { <%= module_name %> }
+
+  # describe ".configure" do
+  #
+  #   it "is public" do
+  #     expect(subject).to respond_to(:configure).with(0).arguments
+  #   end
+  #
+  #   it "sends module to a block" do
+  #     subject.configure do |c|
+  #       expect(c).to eq subject
+  #     end
+  #   end
+  # end
+end

data/lib/generators/domain/domain.rb

@@ -0,0 +1,24 @@
+require_relative "../base"
+
+module Hexx
+  module Generators
+
+    # Use case scaffolder.
+    class Domain < Base
+
+      def self.source_root
+        super __FILE__
+      end
+
+      def add_spec
+        template "spec.erb", "spec/#{ domain_path }/#{ file_name }_spec.rb"
+      end
+
+      private
+
+      def domain_path
+        "domain/#{ gem_name }"
+      end
+    end
+  end
+end

data/lib/generators/domain/templates/spec.erb

@@ -0,0 +1,84 @@
+require "spec_helper"
+
+module <%= module_name %>
+  describe "<%= class_name %>" do
+
+    # ==========================================================================
+    # Prepare environment
+    # ==========================================================================
+
+    # before do
+    #   # Timecop.travel Time.now - 100
+    #   # prepare initial values
+    #   # Timecop.return
+    # end
+
+    # before { Timecop.freeze }
+    # after  { Timecop.return }
+
+    # ==========================================================================
+    # Prepare variables
+    # ==========================================================================
+
+    # let!(:params) { { something: something } }
+    # let!(:listener) { double "listener" }
+
+    # let!(:expected_result) do
+    #   OpenStruct.new(
+    #     something: something
+    #   ).inspect
+    # end
+
+    # ==========================================================================
+    # Run tests
+    # ==========================================================================
+
+    # context "with valid params" do
+
+    #   let!(:use_case) { <%= class_name %>.new params }
+
+    #   it "returns something" do
+    #     expect(use_case.run.inspect).to eq expected_result
+    #   end
+
+    #   it "notifies listeners" do
+    #     use_case.subscribe listener
+    #     expect(listener).to receive(:something) do |item|
+    #       expect(item.inspect).to eq expected_result
+    #     end
+    #     use_case.run
+    #   end
+
+    #   it "changes something" do
+    #     expect { use_case.run }
+    #       .to change { something }
+    #       .from(something)
+    #       .to(something)
+    #   end
+    # end
+
+    # context "with invalid params" do
+
+    #   before { params[:something] = something }
+    #   let!(:use_case) { <%= class_name %>.new params }
+
+    #   it "returns nil" do
+    #     expect(use_case.run).to be_nil
+    #   end
+
+    #   it "notifies listeners" do
+    #     use_case.subscribe listener
+    #     expect(listener).to receive(:error) do |message|
+    #       expect(message).not_to be_blank
+    #     end
+    #     use_case.run
+    #   end
+
+    #   it "doesn't change something" do
+    #     expect { use_case.run }
+    #       .not_to change { something }
+    #       .from something
+    #   end
+    # end
+  end
+end

data/lib/generators/install/install.rb

@@ -0,0 +1,115 @@
+require "thor"
+require "extlib"
+
+module Hexx
+  module Generators
+
+    # Project scaffolder
+    class Install < Thor::Group
+      include Thor::Actions
+
+      def self.source_root
+        root = File.dirname File.expand_path(__FILE__)
+        @source_root ||= File.join(root, "templates")
+      end
+
+      argument :name
+
+      def remove_app
+        run "rm app -f -r"
+      end
+
+      def update_bin
+        template "bin/rails.erb", "bin/rails", force: true
+      end
+
+      def update_config
+        template "config/routes.erb", "config/routes.rb", force: true
+        run "mkdir config/locales"
+      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_spec_helper
+        template(
+          "spec/spec_helper.erb",
+          "spec/spec_helper.rb",
+          force: true
+        )
+      end
+
+      def add_spec_initializers
+        run "mkdir spec/support"
+        run "mkdir #{ supports }"
+        initializers.each do |name|
+          template(
+            "spec/#{ name }.erb",
+            "#{ supports }/#{ name }.rb",
+            force: true
+          )
+        end
+      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
+      end
+
+      def add_docs
+        template "CHANGELOG.erb", "CHANGELOG.rdoc", force: true
+        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
+        )
+      end
+
+      def run_docs
+        run "subl README.rdoc" \
+            " lib/#{ gem_name }.rb" \
+            " #{ gem_name }.gemspec"
+      end
+
+      private
+
+      def gem_name
+        @gem_name ||= name.snake_case
+      end
+
+      def module_name
+        @module_name ||= name.camel_case
+      end
+
+      def supports
+        "spec/support/initializers"
+      end
+
+      def initializers
+        %w(
+          coveralls database_cleaner factory_girl factory_girl_rails focus
+          garbage_collection i18n migrations rails random_order rspec timecop
+        )
+      end
+    end
+  end
+end