hexx 1.1.1 → 2.0.0

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

@@ -1,45 +0,0 @@
-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
-
-Bundler::GemHelper.install_tasks
-
-APP_RAKEFILE = File.expand_path "../spec/dummy/Rakefile", __FILE__
-load "rails/tasks/engine.rake"
-
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new :spec
-
-task :default do
-  system "mkdir spec/dummy/tmp/cache -p -v"
-  system "bundle exec rake db:migrate RAILS_ENV=test"
-  system "bundle exec rspec spec"
-end
-
-task :check do
-  system "coveralls report"
-  system "rubocop"
-  system "metric_fu"
-  system "inch --pedantic"
-  system "rails_best_practices"
-end

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

@@ -1 +0,0 @@
-service_name: travis-ci

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

@@ -1,33 +0,0 @@
-$:.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",    "~> 1.0.2"
-  s.add_runtime_dependency "jbuilder"
-  s.add_runtime_dependency "rails"
-
-  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 "metric_fu"
-  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/root/gitignore.erb

@@ -1,28 +0,0 @@
-*.a
-*.bundle
-*.gem
-*.o
-*.rbc
-*.so
-.bundle
-.config
-.yardoc
-_yardoc
-coverage
-doc/
-Gemfile.lock
-InstalledFiles
-lib/bundler/man
-log
-mkmf.log
-pkg
-rdoc
-spec/dummy/.sass-cache
-spec/dummy/db/*.sqlite3
-spec/dummy/db/*.sqlite3-journal
-spec/dummy/log
-spec/dummy/tmp
-spec/reports
-test/tmp
-test/version_tmp
-tmp

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

@@ -1 +0,0 @@
---color

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

@@ -1,65 +0,0 @@
-AllCops:
-  Exclude:
-    - 'spec/dummy/**/*'
-    - 'Rakefile'
-
-Lint/HandleExceptions:
-  Exclude:
-    - 'spec/**/*'
-
-Lint/RescueException:
-  Exclude:
-    - 'spec/**/*'
-
-Style/AccessorMethodName:
-  Exclude:
-    - 'spec/**/*'
-
-Style/AsciiComments:
-  Enabled: false
-
-Style/ClassAndModuleChildren:
-  Exclude:
-    - 'spec/**/*'
-
-Style/Documentation:
-  Exclude:
-    - 'spec/**/*'
-    - 'db/**/*'
-
-Style/EmptyLinesAroundBody:
-  Enabled: false
-
-Style/EmptyLineBetweenDefs:
-  Exclude:
-    - 'spec/**/*'
-
-Style/MethodLength:
-  Exclude:
-    - 'db/**/*'
-
-Style/RaiseArgs:
-  EnforcedStyle: compact
-
-Style/SingleLineMethods:
-  Exclude:
-    - 'spec/**/*'
-
-Style/SpecialGlobalVars:
-  Exclude:
-    - 'Gemfile'
-    - '*.gemspec'
-
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
-
-Style/SingleSpaceBeforeFirstArg:
-  Enabled: false
-
-Style/TrailingBlankLines:
-  Exclude:
-    - 'app/views/**/*'
-
-Style/TrivialAccessors:
-  Exclude:
-    - 'spec/**/*'

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

@@ -1,3 +0,0 @@
-language: ruby
-rvm:
-  - 2.1

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

@@ -1,12 +0,0 @@
-require "rails"
-require "rspec/rails"
-
-RSpec.configure do |config|
-  config.around(:each, :caching) do |example|
-    caching = ActionController::Base.perform_caching
-    ActionController::Base.perform_caching = example.metadata[:caching]
-    example.run
-    Rails.cache.clear
-    ActionController::Base.perform_caching = caching
-  end
-end

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

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

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

@@ -1,28 +0,0 @@
-require "database_cleaner"
-require "rspec/rails"
-
-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_rails.erb

@@ -1,5 +0,0 @@
-require "factory_girl_rails"
-
-RSpec.configure do |config|
-  config.include FactoryGirl::Syntax::Methods
-end

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

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

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

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

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

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

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

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

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

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

@@ -1,10 +0,0 @@
-RSpec.configure do |config|
-
-  config.mock_with :rspec do |mocks|
-    mocks.yield_receiver_to_any_instance_implementation_blocks = false
-  end
-
-  config.expect_with :rspec do |c|
-    c.syntax = :expect
-  end
-end

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

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

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

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

data/lib/generators/request/request.rb

@@ -1,52 +0,0 @@
-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].to_s
-      end
-
-      # type of action: "get"
-      def action_type
-        @action_type ||= parts[0].to_s
-      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

@@ -1,66 +0,0 @@
-require "spec_helper"
-
-module <%= module_name %>
-  describe "<%= action_type.upcase %> api/v1/<%= full_name %>" do
-
-    # ==========================================================================
-    # Prepare context
-    # ==========================================================================
-
-    # let!(:something) { something }
-
-    # ==========================================================================
-    # Prepare variables
-    # ==========================================================================
-
-    # let!(:params) { { "something" => something } }
-
-    # def call_request(params)
-    #   <%= action_type %> "<%= gem_name %>/api/v1/<%= escaped_name %>", params
-    # end
-
-    # ==========================================================================
-    # Run tests
-    # ==========================================================================
-
-    # context "with proper params" do
-
-    #   before { call_request params }
-
-    #   it "changes something" do
-    #     expect(something).to eq something
-    #   end
-
-    #   it "responds with 200" do
-    #     expect(response.status).to eq 200
-    #   end
-
-    #   it "receives proper json" do
-    #     expect(response.body).to match_json_schema(:something)
-    #   end
-
-    #   it "receives something" do
-    #     something = JSON.parse(response.body)["something"]
-    #     expect(something).to eq something
-    #   end
-    # end
-
-    # context "with wrong params" do
-    #
-    #   before { params["something"] = something }
-    #   before { call_request params }
-
-    #   it "doesn't change something" do
-    #     expect(something).to eq something
-    #   end
-
-    #   it "responds with 400" do
-    #     expect(response.status).to eq 400
-    #   end
-
-    #   it "receives proper json" do
-    #     expect(response.body).to match_json_schema(:get_errors)
-    #   end
-    # end
-  end
-end

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

@@ -1,54 +0,0 @@
-module <%= module_name %>
-
-  # TODO: What does the case do?
-  #
-  # @example
-  #     use_case = <%= class_name %>.new(TODO: TODO)
-  #     use_case.subscribe some_listener
-  #     use_case.run
-  #
-  # Methods:
-  # <tt>.new</tt>:: initializes a use case with some uuid.
-  # <tt>#subscribe</tt>:: subscribes listeners for <tt>#run</tt>'s notifications
-  # <tt>#run</tt>:: runs a case and returns TODO or +nil+
-  # <tt>#run!</tt>:: runs a case. Fails if no firm found.
-  #
-  # The +run+ method returns TODO (or +nil+) and notifies its listeners:
-  # <tt>:TODO</tt>:: when TODO.
-  #
-  class <%= class_name %> < Hexx::UseCase
-
-    # Allow necessary parameters here:
-    # allow_params :some_parameter, :another_one
-
-    # Add case-specific validations
-    # validates :some_attribute, presence: true
-
-    # Runs the case and fails if TODO.
-    #
-    # @example
-    #     <%= class_name %>.new(TODO: TODO).run!
-    #     # => #<<%= module_name %>::TODO ...>
-    #
-    #     <%= class_name %>.new.run!
-    #     # => fails with #<TODO ...>
-    #
-    def run!
-      validate!
-      # describe other rules here
-    end
-
-    private
-
-    # Define custom validations
-    # def something_valid?
-    #   return unless something
-    #   errors.add :some_attribute, :some_key
-    # end
-
-    # Define virtual attributes to validate
-    # def some_attribute
-    #   @some_attribute ||= params["some_param"]
-    # end
-  end
-end

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

@@ -1,74 +0,0 @@
-require "spec_helper"
-
-module <%= module_name %>
-  describe <%= class_name %> do
-
-    # ==========================================================================
-    # Prepare context
-    # ==========================================================================
-
-    # let!(:something) { create :something }
-
-    # ==========================================================================
-    # Prepare variables
-    # ==========================================================================
-
-    # let!(:params)  { { "key" => value } }
-    # let(:listener) { double "listener" }
-
-    # def prepare_case(params)
-    #   use_case = <%= class_name %>.new params
-    #   use_case.subscribe(listener)
-    #   use_case
-    # end
-
-    # ==========================================================================
-    # Run tests
-    # ==========================================================================
-
-    describe "#run" do
-
-      # context "with valid params" do
-
-      #   subject(:use_case) { prepare_case params }
-
-      #   it "does something" do
-      #     expect { use_case.run }.to change { something }.to(something)
-      #   end
-
-      #   it "returns something" do
-      #     expect(use_case.run).to eq expected_result
-      #   end
-
-      #   it "sends 'something' to subscribers" do
-      #     expect(listener).to receive :something do |result, messages|
-      #       expect(result).to eq expected_result
-      #       expect(messages).not_to be_blank
-      #     end
-      #     use_case.run
-      #   end
-      # end
-
-      # context "with invalid params" do
-
-      #   before { params[:something] = something }
-      #   subject(:use_case) { prepare_case params }
-
-      #   it "doesn't do something" do
-      #     expect { use_case.run }.not_to change { something }
-      #   end
-
-      #   it "returns nil" do
-      #     expect(use_case.run).to be_nil
-      #   end
-
-      #   it "sends 'error' to subscribers" do
-      #     expect(listener).to receive :error do |messages|
-      #       expect(messages).not_to be_blank
-      #     end
-      #     use_case.run
-      #   end
-      # end
-    end
-  end
-end

data/lib/generators/use_case/use_case.rb

@@ -1,31 +0,0 @@
-require_relative "../base"
-
-module Hexx
-  module Generators
-
-    # Use case scaffolder.
-    class UseCase < Base
-
-      def self.source_root
-        super __FILE__
-      end
-
-      def add_use_case
-        template "use_case.erb", "app/#{ use_cases_path }/#{ file_name }.rb"
-      end
-
-      def add_use_case_spec
-        template(
-          "use_case_spec.erb",
-          "spec/#{ use_cases_path }/#{ file_name }_spec.rb"
-        )
-      end
-
-      private
-
-      def use_cases_path
-        "use_cases/#{ gem_name }"
-      end
-    end
-  end
-end

data/lib/hexx/exceptions/not_found_error.rb

@@ -1,18 +0,0 @@
-require_relative "runtime_error"
-
-module Hexx
-
-  # An exception to be raised in case some record not found
-  #
-  # It is expected, that the object stores error messages in its <tt>errors</tt>
-  # collection.
-  #
-  class NotFoundError < RuntimeError
-
-    private
-
-    def default
-      "Not found"
-    end
-  end
-end

data/lib/hexx/exceptions/runtime_error.rb

@@ -1,27 +0,0 @@
-module Hexx
-
-  # An exception to be raised by some method with given object.
-  #
-  # It is expected, that the object stores error messages in its <tt>errors</tt>
-  # collection.
-  #
-  class RuntimeError < ::RuntimeError
-
-    attr_reader :messages
-
-    def initialize(object)
-      fail ArgumentError unless object.is_a? UseCase
-      @messages ||= object.errors.messages.values.flatten
-    end
-
-    def message
-      @message ||= "#{ default }: #{ messages.join("; ") }"
-    end
-
-    private
-
-    def default
-      "Runtime error"
-    end
-  end
-end

data/lib/hexx/exceptions/use_case_invalid.rb

@@ -1,18 +0,0 @@
-require_relative "runtime_error"
-
-module Hexx
-
-  # An exception to be raised by the <tt>UseCase#validate!</tt> method.
-  #
-  # It is expected, that the object stores error messages in its <tt>errors</tt>
-  # collection.
-  #
-  class UseCaseInvalid < RuntimeError
-
-    private
-
-    def default
-      "Use case invalid"
-    end
-  end
-end

data/lib/hexx/message.rb

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