barite 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1dc754c61e3fc1e80c733744320dd5aa5e16b452
+  data.tar.gz: 4c2e43d5979f7ac75452cb9befb0c493a769e686
+SHA512:
+  metadata.gz: 5c3656c205d4baf80ca287f9e426e0d895c9d24c981aff9956314a0c3bcabd9c7aa748f6fc585b6dc58600b66107a778a74cab6083d47d7817b14fa4fd35ed6e
+  data.tar.gz: 29cd781550aa2f2978dce565026d959a2edc43c035474746ddae1cd5c9bd1c6e88c8ce6fac25f173a4eca67c550a9f728c38092184b3a6f7a675f2cf00576509

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 weathare
+
+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/README.md

@@ -0,0 +1,64 @@
+# Barite
+
+Ruby on Rails (with RSpec) custom generators.
+
+[![Build Status](https://travis-ci.org/weathare/barite.svg?branch=master)](https://travis-ci.org/weathare/barite)
+
+## Usage
+
+### app/serializers
+
+```bash
+$ rails g response NAME
+```
+
+### app/*/concerns
+
+```bash
+// controllers module
+$ rails g concern:controller NAME
+
+// model module
+$ rails g concern:model NAME
+```
+
+### spec/*/*_spec.rb
+
+inject test code with included modules
+
+```bash
+// controller
+$ rails g concern:rspec MODULE_NAME --controller CONTROLLER_NAME
+
+// model
+$ rails g concern:rspec MODULE_NAME --model MODEL_NAME
+```
+
+### rambulance setup
+
+```bash
+$ rails g rambulance:setup
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'barite'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install barite
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,17 @@
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+require "rdoc/task"
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title    = "Barite"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.md")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end
+
+require "bundler/gem_tasks"

data/lib/barite.rb

@@ -0,0 +1,11 @@
+module Barite; end
+module Concern; end
+module Rails::Serializer; end
+
+require "rails/generators"
+require "barite/version"
+require "generators/concern/controller/controller_generator"
+require "generators/concern/model/model_generator"
+require "generators/concern/rspec/rspec_generator"
+require "generators/rambulance/setup/setup_generator"
+require "generators/rails/response_generator"

data/lib/barite/version.rb

@@ -0,0 +1,3 @@
+module Barite
+  VERSION = "0.1.0"
+end

data/lib/generators/concern/controller/controller_generator.rb

@@ -0,0 +1,9 @@
+class Concern::ControllerGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path("../../templates", __FILE__)
+
+  def create_concerns
+    setting_path = "controllers/concerns"
+    template "concern.erb", File.join("app", setting_path, class_path, "#{file_name}.rb")
+    template "controller_spec.erb", File.join("spec", setting_path, class_path, "#{file_name}_spec.rb")
+  end
+end

data/lib/generators/concern/model/model_generator.rb

@@ -0,0 +1,33 @@
+class Concern::ModelGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path("../../templates", __FILE__)
+
+  def create_concerns
+    setting_path = "models/concerns"
+    template "concern.erb", File.join("app", setting_path, class_path, "#{file_name}.rb")
+    template "model_spec.erb", File.join("spec", setting_path, class_path, "#{file_name}_spec.rb")
+  end
+
+  def copy_rspec_helper
+    copy_file("mock_table_helper.rb", "spec/support/mock_table_helper.rb") if invoke?
+  end
+
+  def inject_code
+    rspec_helper = Rails.root.join(*%w[spec rails_helper.rb])
+    inject_into_file rspec_helper, before: /^ActiveRecord::Migration\.maintain_test_schema!/ do <<-'CODE'
+Dir[Rails.root.join("spec/support/**/*.rb")].each { |f| require f }
+
+    CODE
+    end if injectable?(rspec_helper)
+  end
+
+  private
+    def invoke?
+      self.behavior == :invoke
+    end
+
+    def injectable?(file_path)
+      if invoke?
+        !(File.read(file_path) =~ /^Dir.+spec\/support\/.+\.rb.+require f/)
+      end
+    end
+end

data/lib/generators/concern/rspec/rspec_generator.rb

@@ -0,0 +1,65 @@
+require "active_support/inflector"
+
+class Concern::RspecGenerator < Rails::Generators::NamedBase
+  class_option(
+    :controller,
+    type: :string,
+    aliases: "-c",
+  )
+
+  class_option(
+    :model,
+    type: :string,
+    aliases: "-m",
+  )
+
+  source_root(File.expand_path("../../templates", __FILE__))
+
+  def generate_spec
+    return unless options[:controller] || options[:model]
+
+    template("base_#{_type}_spec.erb", spec_filepath) if invoke? && !File.exists?(spec_filepath)
+  end
+
+  def copy_shared_spec
+    copy_file("include_module_example.rb", "spec/support/include_module_example.rb") if invoke?
+  end
+
+  def include_spec
+    # [xxx] - destroy の時に不要なコードが挿入されてしまう
+    inject_into_file spec_filepath, content, after: /^RSpec.describe (.+) do\n/
+  end
+
+  private
+    def invoke?
+      self.behavior == :invoke
+    end
+
+    def _type
+      (!!options[:controller]) ? :controller : :model
+    end
+
+    def target_name
+      options[_type].classify
+    end
+
+    def spec_filepath
+      {
+        controller: "_controller_spec.rb",
+        model: "_spec.rb",
+      }.map do |type, postfix|
+        File.join(*%W[spec #{type}s #{options[type]}#{postfix}]) if !!options&.[](type)
+      end.compact.pop
+    end
+
+    def content
+      <<-'CODE'
+  describe "Included module" do
+    subject { [class_name] }
+
+    include_examples "included modules"
+  end
+      CODE
+        .gsub(/class_name/, class_name)
+    end
+end

data/lib/generators/concern/templates/base_controller_spec.erb

@@ -0,0 +1,4 @@
+require "rails_helper"
+
+RSpec.describe <%= target_name %>, type: :controller do
+end

data/lib/generators/concern/templates/base_model_spec.erb

@@ -0,0 +1,4 @@
+require "rails_helper"
+
+RSpec.describe <%= target_name %>, type: :model do
+end

data/lib/generators/concern/templates/concern.erb

@@ -0,0 +1,11 @@
+module <%= class_name %>
+  extend ActiveSupport::Concern
+
+  included do
+    # some callbacks ...
+  end
+
+  class_methods do
+    # some methods ...
+  end
+end

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

@@ -0,0 +1,34 @@
+require "rails_helper"
+
+class <%= class_name %> < ApplicationController
+  include ::<%= class_name %>
+  # some fixtures code ...
+end
+
+RSpec.describe <%= class_name %>, type: :controller do
+  controller <%= class_name %> do
+    def index
+      render(
+        status: 200,
+        plain: request_status.to_s,
+      )
+    end
+  end
+
+  before do
+    routes.draw { get "/" => "<%= class_name.split("::").last.underscore %>#index" }
+  end
+
+  describe "Include mix-in" do
+    subject do
+      get :index, params: params
+      response.body
+    end
+
+    context "{test case}" do
+      # test case code...
+      # let(:params) { nil }
+      # it { expect { subject }.to raise_error({some exception}) }
+    end
+  end
+end

data/lib/generators/concern/templates/include_module_example.rb

@@ -0,0 +1,5 @@
+shared_examples_for "included modules" do
+  it do
+    is_expected.to include *described_class.included_modules
+  end
+end

data/lib/generators/concern/templates/mock_table_helper.rb

@@ -0,0 +1,15 @@
+def create_mock_table(name, &block)
+  raise "no block given." unless block_given?
+
+  before(:all) do
+    m = ActiveRecord::Migration.new
+    m.verbose = false
+    m.create_table(name, &block)
+  end
+
+  after(:all) do
+    m = ActiveRecord::Migration.new
+    m.verbose = false
+    m.drop_table(name)
+  end
+end

data/lib/generators/concern/templates/model_spec.erb

@@ -0,0 +1,20 @@
+require "rails_helper"
+
+RSpec.describe <%= class_name %>, type: :model do
+  create_mock_table(:module_<%= plural_name %>) do |t|
+    # any attributes
+    t.timestamps
+  end
+
+  class Module<%= class_name.split("::").last %> < ApplicationRecord
+    include ::<%= class_name %>
+  end
+
+  describe "Included mix-in" do
+    subject do
+      Module<%= class_name.split("::").last %>.included_modules
+    end
+
+    it { is_expected.to include described_class }
+  end
+end

data/lib/generators/rails/response_generator.rb

@@ -0,0 +1,24 @@
+require "active_model_serializers"
+require "generators/rails/serializer_generator"
+
+class Rails::ResponseGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path("../templates", __FILE__)
+
+  def create_serializer_file
+    if invoke?
+      generate :serializer, name
+    else
+      ::Rails::Command.invoke :destroy, ["serializer", name]
+    end
+  end
+
+  def create_response_file
+    template "serializer_spec.erb", File.join("spec/serializers", class_path, "#{file_name}_serializer_spec.rb")
+    copy_file("active_model_serializers_helper.rb", "spec/support/active_model_serializers_helper.rb") if invoke?
+  end
+
+  private
+    def invoke?
+      self.behavior == :invoke
+    end
+end

data/lib/generators/rails/templates/active_model_serializers_helper.rb

@@ -0,0 +1,39 @@
+module ActiveModelSerializersHelper
+  def serialize(obj, **options)
+    serializer_class = options.delete(:serializer_class) || "#{obj.class.name}Serializer".constantize
+    klass = serializer_class.new(obj)
+    ActiveModelSerializers::Adapter.create(klass, options)
+  end
+
+  def attributes_as_json(factory)
+    factory.attributes.map do |name, value|
+      _value =
+        case value
+        when Time, Date, DateTime
+          value.iso8601
+        else
+          value
+        end
+      [name, _value]
+    end.to_h
+  end
+end
+
+shared_examples_for "serialize attributes" do
+  let(:not_coverd) do
+    attrs = factory.attribute_names
+    attrs.delete_if do |item|
+      item =~ /^(#{include_attrs.join("|")})$/
+    end
+    attrs.map(&:to_sym)
+  end
+
+  subject { serialized.serializable_hash }
+
+  it { is_expected.to include *include_attrs }
+  it { is_expected.not_to include *not_coverd }
+end
+
+RSpec.configure do |config|
+  config.include ActiveModelSerializersHelper, type: :serializer
+end

data/lib/generators/rails/templates/serializer_spec.erb

@@ -0,0 +1,35 @@
+require "rails_helper"
+
+RSpec.describe <%= class_name %>, type: :serializer do
+  let(:klass) do
+    Class.new do
+      include ActiveModel::Serialization
+      include ActiveModel::Model
+
+      def attributes
+        {
+          created_at: created_at
+        }
+      end
+
+      def attribute_names
+        attributes.keys.map(&:to_s)
+      end
+
+      def created_at
+        Time.current
+      end
+    end
+  end
+
+  let(:factory) { klass.new }
+
+  describe "attributes" do
+    let(:serialized) { serialize(factory, serializer_class: described_class) }
+    let(:factory_json) { attributes_as_json(factory) }
+
+    it(:match) do
+      expect(serialized.serializable_hash).to include_json(**factory_json)
+    end
+  end
+end

data/lib/generators/rambulance/setup/setup_generator.rb

@@ -0,0 +1,11 @@
+require "rambulance"
+
+class Rambulance::SetupGenerator < Rails::Generators::Base
+  source_root File.expand_path("../../templates", __FILE__)
+
+  def copy_rambulance
+    copy_file("initializers.rb", "config/initializers/rambulance.rb")
+    copy_file("handler.rb", "app/handlers/exceptions_app.rb")
+    copy_file("handler_spec.rb", "spec/handlers/exceptions_app_spec.rb")
+  end
+end

data/lib/generators/rambulance/templates/handler.rb

@@ -0,0 +1,26 @@
+class ExceptionsApp < Rambulance::ExceptionsApp
+  %i[
+    not_found
+    conflict
+    unprocessable_entity
+    method_not_allowed
+    not_implemented
+    bad_request
+    internal_server_error
+    unauthorized
+  ].each do |name|
+    define_method name do
+      render json: message(name)
+    end
+  end
+
+  private
+    def message(method)
+      {
+        error: method.to_s.humanize,
+      }.tap do |element|
+        element[:request] =
+          %(#{request&.env&.[]("REQUEST_METHOD")} #{request&.env&.[]("REQUEST_URI")})
+      end if defined?(request)
+    end
+end

data/lib/generators/rambulance/templates/handler_spec.rb

@@ -0,0 +1,39 @@
+require "rails_helper"
+
+RSpec.describe ExceptionsApp do
+  subject do
+    described_class.new
+  end
+
+  context "Defined method that corresponding to HTTP Status" do
+    %i[
+      not_found
+      conflict
+      unprocessable_entity
+      method_not_allowed
+      not_implemented
+      bad_request
+      internal_server_error
+      unauthorized
+    ].each do |name|
+      it(name) { is_expected.to respond_to name }
+    end
+  end
+
+  context "Make message" do
+    %i[
+      not_found
+      conflict
+      unprocessable_entity
+      method_not_allowed
+      not_implemented
+      bad_request
+      internal_server_error
+      unauthorized
+    ].each do |name|
+      it(name) do
+        expect(subject.send(:message, name)).to include error: name.to_s.humanize
+      end
+    end
+  end
+end

data/lib/generators/rambulance/templates/initializers.rb

@@ -0,0 +1,20 @@
+Rambulance.setup do |config|
+
+  # @see http://www.rubydoc.info/gems/actionpack-rack-upgrade/ActionController/Rescue
+  config.rescue_responses = {
+    "ActionController::RoutingError"             => :not_found,
+    "ActionController::UnknownAction"            => :not_found,
+    "ActiveRecord::RecordNotFound"               => :not_found,
+    "ActiveRecord::StaleObjectError"             => :conflict,
+    "ActiveRecord::RecordInvalid"                => :unprocessable_entity,
+    "ActiveRecord::RecordNotSaved"               => :unprocessable_entity,
+    "ActiveRecord::RecordNotUnique"              => :conflict,
+    "ActionController::MethodNotAllowed"         => :method_not_allowed,
+    "ActionController::NotImplemented"           => :not_implemented,
+    "ActionController::InvalidAuthenticityToken" => :unprocessable_entity,
+    "AttrExtras::MethodNotImplementedError"      => :internal_server_error,
+  }
+
+  config.layout_name = nil
+  config.view_path = nil
+end

metadata

@@ -0,0 +1,192 @@
+--- !ruby/object:Gem::Specification
+name: barite
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- weathare
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: active_model_serializers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: attr_extras
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.2
+- !ruby/object:Gem::Dependency
+  name: rambulance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ammeter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-highlight
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: RailsRails API patters generator.
+email:
+- fuzuki.close@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/barite.rb
+- lib/barite/version.rb
+- lib/generators/concern/controller/controller_generator.rb
+- lib/generators/concern/model/model_generator.rb
+- lib/generators/concern/rspec/rspec_generator.rb
+- lib/generators/concern/templates/base_controller_spec.erb
+- lib/generators/concern/templates/base_model_spec.erb
+- lib/generators/concern/templates/concern.erb
+- lib/generators/concern/templates/controller_spec.erb
+- lib/generators/concern/templates/include_module_example.rb
+- lib/generators/concern/templates/mock_table_helper.rb
+- lib/generators/concern/templates/model_spec.erb
+- lib/generators/rails/response_generator.rb
+- lib/generators/rails/templates/active_model_serializers_helper.rb
+- lib/generators/rails/templates/serializer_spec.erb
+- lib/generators/rambulance/setup/setup_generator.rb
+- lib/generators/rambulance/templates/handler.rb
+- lib/generators/rambulance/templates/handler_spec.rb
+- lib/generators/rambulance/templates/initializers.rb
+homepage: https://github.com/weathare/barite
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: RailsRails API patters generator.
+test_files: []