hexx 0.0.1

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

@@ -0,0 +1 @@
+= CHANGELOG

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

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "coveralls", require: false

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

@@ -0,0 +1,21 @@
+= The MIT License
+
+Copyright (c) 2014 Andrew Kozin, https://github.com/nepalez
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

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

@@ -0,0 +1,55 @@
+= <%= module_name %>
+
+{<img src="http://img.shields.io/travis/nepalez/<%= gem_name %>.svg?style=flat" alt="Bild Status" />}[https://travis-ci.org/nepalez/<%= gem_name %>]
+{<img src="http://img.shields.io/codeclimate/github/nepalez/<%= gem_name %>.svg?style=flat" alt="Code Metrics" />}[https://codeclimate.com/github/nepalez/<%= gem_name %>]
+{<img src="http://img.shields.io/gemnasium/nepalez/<%= gem_name %>.svg?style=flat" alt="Dependency Status" />}[https://gemnasium.com/nepalez/<%= gem_name %>]
+{<img src="http://img.shields.io/coveralls/nepalez/<%= gem_name %>.svg?style=flat" alt="Coverage Status" />}[https://coveralls.io/r/nepalez/<%= gem_name %>]
+{<img src="http://img.shields.io/badge/license-MIT-blue.svg?style=flat" alt="License" />}[https://github.com/nepalez/<%= gem_name %>/blob/master/LICENSE.rdoc]
+
+== About
+
+TODO: Write a gem description
+
+=== UseCases
+
+<tt><%= model_name %>::DoSomething</tt>::
+    TODO: describe a use case.
+
+=== Models
+
+<tt><%= model_name %>::Something</tt>::
+    TODO: describe a model.
+
+=== Dependencies
+
+<tt><%= model_name %>.get_something_name</tt>::
+    TODO: describe a dependency.
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+    gem "<%= gem_name %>"
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install <%= gem_name %>
+
+Then run from a command line:
+
+    $ rails g users:install
+
+This will create a <tt>config/initializers/<%= gem_name %>.rb</tt> with module settings.
+Review the file and change default values.
+
+== Contributing
+
+1. Fork it ( https://github.com/nepalez/<%= gem_name %>/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

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

@@ -0,0 +1,34 @@
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+begin
+  require "rdoc/task"
+rescue LoadError
+  require "rdoc/rdoc"
+  require "rake/rdoctask"
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title    = "<%= module_name %>"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include "README.rdoc"
+  rdoc.rdoc_files.include "lib/**/*.rb"
+end
+
+APP_RAKEFILE = File.expand_path "../spec/dummy/Rakefile", __FILE__
+load "rails/tasks/engine.rake"
+
+Bundler::GemHelper.install_tasks
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new :spec
+task :default do
+  sh "bundle exec rspec spec"
+end

data/lib/generators/install/templates/bin/rails.erb

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+ENGINE_ROOT = File.expand_path "../..", __FILE__
+ENGINE_PATH = File.expand_path "../../lib/<%= gem_name %>/engine", __FILE__
+
+# Set up gems listed in the Gemfile.
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path "../../Gemfile", __FILE__
+require "bundler/setup" if File.exist? ENV["BUNDLE_GEMFILE"]
+
+require "rails/all"
+require "rails/engine/commands"

data/lib/generators/install/templates/config/routes.erb

@@ -0,0 +1,6 @@
+<%= module_name %>::Engine.routes.draw do
+  # namespace :api, defaults: { format: "json" } do
+  #   namespace :v1 do
+  #   end
+  # end
+end

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

@@ -0,0 +1,29 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "<%= gem_name %>/version"
+
+Gem::Specification.new do |s|
+  s.name        = "<%= gem_name %>"
+  s.version     = <%= module_name %>::VERSION
+  s.author      = "Andrew Kozin"
+  s.email       = "andrew.kozin@gmail.com"
+  s.homepage    = "https://github.com/nepalez/<%= gem_name %>"
+  s.summary     = "TODO: Summary of <%= module_name %>."
+  s.description = "TODO: Description of <%= module_name %>."
+  s.license     = "MIT"
+  s.platform    = Gem::Platform::RUBY
+  s.required_ruby_version = "~> 2.1"
+
+  s.files            = Dir["{app,config,db,lib}/**/*"]
+  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 "rails"
+
+  s.add_development_dependency "database_cleaner"
+  s.add_development_dependency "factory_girl_rails"
+  s.add_development_dependency "rspec-rails"
+  s.add_development_dependency "rubocop"
+  s.add_development_dependency "sqlite3"
+  s.add_development_dependency "timecop"
+end

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

@@ -0,0 +1,12 @@
+module <%= module_name %>
+
+  # Rails Engine settings
+  class Engine < ::Rails::Engine
+    isolate_namespace <%= module_name %>
+
+    config.generators do |g|
+      g.test_framework :rspec, fixture: true, view_specs: true
+      g.fixture_replacement :factory_girl, dir: "spec/factories"
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+require "hexx"
+require "rails"
+
+lib = File.dirname(__FILE__)
+Dir[File.join(lib, "<%= gem_name %>/**/*.rb")].each { |file| require file }
+
+# TODO: describe a module.
+module <%= module_name %>
+  include Hexx::Settings
+end

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

@@ -0,0 +1,4 @@
+# Current release.
+module <%= module_name %>
+  VERSION = "0.0.1-alpha"
+end

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

@@ -0,0 +1,4 @@
+# Check test coverage
+require "coveralls"
+
+Coveralls.wear!

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

@@ -0,0 +1,27 @@
+require "database_cleaner"
+
+RSpec.configure do |config|
+
+  # stop wrapping each of test examples within a transaction
+  config.use_transactional_fixtures = false
+
+  config.before :suite do
+    DatabaseCleaner.clean_with :truncation
+  end
+
+  config.before :each do
+    DatabaseCleaner.strategy = :transaction
+  end
+
+  config.before :each, js: true do
+    DatabaseCleaner.strategy = :truncation
+  end
+
+  config.before :each do
+    DatabaseCleaner.start
+  end
+
+  config.after :each do
+    DatabaseCleaner.clean
+  end
+end

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

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

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

@@ -0,0 +1 @@
+require "factory_girl_rails"

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

@@ -0,0 +1,5 @@
+# Run only tests tagged by :focus
+RSpec.configure do |config|
+  config.filter_run focus: true
+  config.run_all_when_everything_filtered = true
+end

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

@@ -0,0 +1,11 @@
+# Delayg garbage collection to the end of tests
+RSpec.configure do |config|
+
+  config.before(:each) do
+    GC.disable
+  end
+
+  config.after(:each) do
+    GC.enable
+  end
+end

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

@@ -0,0 +1 @@
+I18n.enforce_available_locales = false

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

@@ -0,0 +1,3 @@
+require "active_record"
+
+ActiveRecord::Migration.check_pending! if defined?(ActiveRecord::Migration)

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

@@ -0,0 +1,6 @@
+require "rspec/rails"
+
+RSpec.configure do |config|
+  config.infer_spec_type_from_file_location!
+  config.infer_base_class_for_anonymous_controllers = false
+end

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

@@ -0,0 +1,4 @@
+# Run tests in a random order
+RSpec.configure do |config|
+  config.order = "random"
+end

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

@@ -0,0 +1,5 @@
+RSpec.configure do |config|
+  config.mock_with :rspec do |mocks|
+    mocks.yield_receiver_to_any_instance_implementation_blocks = false
+  end
+end

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

@@ -0,0 +1,12 @@
+ENV["RAILS_ENV"] ||= "test"
+
+root = File.dirname File.dirname(__FILE__)
+
+# Application files
+require File.expand_path("../dummy/config/environment", __FILE__)
+
+# Support files and Rspec settings
+Dir[File.join(root, "spec/support/**/*.rb")].each { |file| require file }
+
+# Factories
+Dir[File.join(root, "spec/factories/**/*.rb")].each { |file| require file }

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

@@ -0,0 +1 @@
+require "timecop"

data/lib/generators/request/request.rb

@@ -0,0 +1,52 @@
+require_relative "../base"
+
+module Hexx
+  module Generators
+
+    # Request spec (acceptance test) scaffolder.
+    class Request < Base
+
+      def self.source_root
+        super __FILE__
+      end
+
+      def create_request_spec
+        template(
+          "request_spec.erb",
+          "spec/#{ requests_path }/#{ action_type }_#{ short_name }_spec.rb"
+        )
+      end
+
+      private
+
+      # path where params changed to 1: "items/1"
+      def escaped_name
+        @escaped_name ||= full_name.gsub(/\{.+\}/, "1")
+      end
+
+      # underscore path: "items_id"
+      def short_name
+        @short_name ||= full_name.gsub(/[\/|\{|\}]+/, "_").gsub(/\_$/, "")
+      end
+
+      # full_path: "items/{id}"
+      def full_name
+        @full_name ||= parts[1]
+      end
+
+      # type of action: "get"
+      def action_type
+        @action_type ||= parts[0]
+      end
+
+      # path from the request: get:items/{id} => ["get", "items/{id}"]
+      def parts
+        @parts ||= name.split(":").map(&:downcase)
+      end
+
+      def requests_path
+        "requests/#{ gem_name }/api/v1"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,73 @@
+require "spec_helper"
+
+module <%= module_name %>
+  describe "<%= action_type.upcase %> api/v1/<%= full_name %>" do
+
+    # ==========================================================================
+    # Prepare environment
+    # ==========================================================================
+
+    # before { Timecop.freeze }
+    # after  { Timecop.return }
+
+    # ==========================================================================
+    # Prepare variables
+    # ==========================================================================
+
+    # let!(:params) { { something: something } }
+
+    # def call_request(params)
+    #   <%= action_type %> "<%= gem_name %>/api/v1/<%= escaped_name %>", params
+    # end
+
+    # def check_results
+    #   get "something", something: something
+    # end
+
+    # ==========================================================================
+    # Run tests
+    # ==========================================================================
+
+    # context "with proper params" do
+
+    #   before { call_request params }
+
+    #   it "receives a proper json response" do
+    #     expect(response).to be_success
+
+    #     json = JSON.parse(response.body)
+    #     expect(json["success"]).to eq true
+    #     expect(json["messages"]).not_to be_blank
+    #     expect(json["data"]).to eq(
+    #       "something" => something,
+    #     )
+    #   end
+
+    #   it "changes something" do
+    #     check_results
+    #     json = JSON.parse(response.body)
+    #     expect(json["data"]).to eq(something)
+    #   end
+    # end
+
+    # context "with invalid params" do
+    #
+    #   before { params[:something] = something }
+    #   before { call_request params }
+
+    #   it "receives a proper json response" do
+    #     expect(response).not_to be_success
+
+    #     json = JSON.parse(response.body)
+    #     expect(json["success"]).to eq false
+    #     expect(json["messages"]).not_to be_blank
+    #   end
+
+    #   it "doesn't change something" do
+    #     check_results
+    #     json = JSON.parse(response.body)
+    #     expect(json["data"]).to eq(something)
+    #   end
+    # end
+  end
+end

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

@@ -0,0 +1,29 @@
+module <%= module_name %>
+
+  # TODO: add a description
+  class <%= class_name %> < Hexx::UseCase
+
+    # Allow necessary parameters here:
+    # allow_params :some_parameter, :another_one
+
+    # Add case-specific validations
+    # validates :some_attribute, presence: true
+
+    def run!
+      validate!
+      # describe other rules here
+    end
+
+    private
+
+    # Define virtual attributes to validate
+    # def some_attribute
+    #   @some_attribute ||= params["some_param"]
+    # end
+
+    # Define custom validations
+    # def something_valid?
+    #   errors.add :some_attribute, :some_key
+    # end
+  end
+end