poro-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e61370f0517e5bc901163403d8df618537c45902a27cc8e0b1719d5f2319901e
+  data.tar.gz: 7d03959dda8e873142976982cb710e159df8d5bcdf64b18aa41837c2047efa64
+SHA512:
+  metadata.gz: db1d20a36a95b987d56ca16b016f369f0e172f1f8c34f0ca2e3d660e42c711406fe6eb2872d166f189e5a8850fc2cd4a9de712f66d8337e9bfa3acc71bfdfb9c
+  data.tar.gz: 4e7b01940f411c2e530127d3735f1c041f74f3877c242afc4ecde8966fdf82377f2c29905a460bb98f9a2576feadc37f00484193571be526a6f1b5a18f7321f3

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/tmp/
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in poro-rails.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Yoshiyuki Hirano
+
+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,104 @@
+# poro-rails
+
+This gem provides generators of **Plain Old Ruby Object** (PORO), **Form Object** and **Service Object** for Ruby on Rails.
+
+## Installation
+
+```ruby
+gem 'poro-rails', group: :development
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install poro-rails
+
+## Usage
+
+### Plain Old Ruby Object
+
+Generate poro via command line:
+
+    $ rails g poro Person
+          create  app/models/person.rb
+          invoke  test_unit
+          create    test/models/person_test.rb
+
+These files are created (if it use RSpec in your project, it creates a spec file):
+
+```ruby
+# app/models/person.rb
+class Person
+  # include ActiveModel::Model
+end
+
+# test/models/person_test.rb
+require 'test_helper'
+
+class PersonTest < ActiveSupport::TestCase
+  # test "the truth" do
+  #   assert true
+  # end
+end
+```
+
+### Form Object
+
+Generate poro via command line:
+
+    $ rails g poro:form create_user
+          create  app/forms/create_user_form.rb
+          invoke  test_unit
+          create    test/forms/create_user_form_test.rb
+
+These files are created (if it use RSpec in your project, it creates a spec file):
+
+```ruby
+# app/forms/create_user_form.rb
+class CreateUserForm
+  # include ActiveModel::Model
+end
+
+# test/forms/create_user_form_test.rb
+require 'test_helper'
+
+class CreateUserFormTest < ActiveSupport::TestCase
+  # test "the truth" do
+  #   assert true
+  # end
+end
+```
+
+### Service Object
+
+Generate poro via command line:
+
+    $ bin/rails g poro:service create_payment
+          create  app/services/create_payment_service.rb
+          invoke  test_unit
+          create    test/services/create_payment_service_test.rb
+
+These files are created (if it use RSpec in your project, it creates a spec file):
+
+```ruby
+# app/services/create_payment_service.rb
+class CreatePaymentService
+  # include ActiveModel::Model
+end
+
+# test/services/create_payment_service_test.rb
+require 'test_helper'
+
+class CreatePaymentServiceTest < ActiveSupport::TestCase
+  # test "the truth" do
+  #   assert true
+  # end
+end
+```
+
+## License
+
+[MIT](https://opensource.org/licenses/MIT)

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/generators/poro/form/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generates a form object with the given name.
+
+Example:
+    rails generate poro:form create_article
+
+    This will create:
+        app/forms/create_article_form.rb

data/lib/generators/poro/form/form_generator.rb

@@ -0,0 +1,22 @@
+module Poro
+  class FormGenerator < Rails::Generators::NamedBase
+    source_root File.expand_path("templates", __dir__)
+    check_class_collision suffix: "Form"
+
+    def create_form
+      template "form.rb.tt", File.join("app/forms", class_path, "#{file_name}_form.rb")
+    end
+
+    hook_for :test_framework
+
+    private
+
+      def file_name
+        @_file_name ||= remove_possible_suffix(super)
+      end
+
+      def remove_possible_suffix(name)
+        name.sub(/_?form$/i, "")
+      end
+  end
+end

data/lib/generators/poro/form/templates/form.rb.tt

@@ -0,0 +1,5 @@
+<% module_namespacing do -%>
+class <%= class_name %>Form
+  # include ActiveModel::Model
+end
+<% end -%>

data/lib/generators/poro/service/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generates a service object with the given name.
+
+Example:
+    rails generate poro:service create_article
+
+    This will create:
+        app/forms/create_article_service.rb

data/lib/generators/poro/service/service_generator.rb

@@ -0,0 +1,22 @@
+module Poro
+  class ServiceGenerator < Rails::Generators::NamedBase
+    source_root File.expand_path("templates", __dir__)
+    check_class_collision suffix: "Service"
+
+    def create_service
+      template "service.rb.tt", File.join("app/services", class_path, "#{file_name}_service.rb")
+    end
+
+    hook_for :test_framework
+
+    private
+
+      def file_name
+        @_file_name ||= remove_possible_suffix(super)
+      end
+
+      def remove_possible_suffix(name)
+        name.sub(/_?service$/i, "")
+      end
+  end
+end

data/lib/generators/poro/service/templates/service.rb.tt

@@ -0,0 +1,5 @@
+<% module_namespacing do -%>
+class <%= class_name %>Service
+  # include ActiveModel::Model
+end
+<% end -%>

data/lib/generators/rails/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generates a plain old ruby object with the given name.
+
+Example:
+    rails generate poro employee
+
+    This will create:
+        app/models/employee.rb

data/lib/generators/rails/poro_generator.rb

@@ -0,0 +1,13 @@
+module Rails
+  module Generators
+    class PoroGenerator < NamedBase
+      source_root File.expand_path("templates", __dir__)
+
+      def create_model
+        template "model.rb.tt", File.join("app/models", class_path, "#{file_name}.rb")
+      end
+
+      hook_for :test_framework
+    end
+  end
+end

data/lib/generators/rails/templates/model.rb.tt

@@ -0,0 +1,5 @@
+<% module_namespacing do -%>
+class <%= class_name %>
+  # include ActiveModel::Model
+end
+<% end -%>

data/lib/generators/rspec/form_generator.rb

@@ -0,0 +1,21 @@
+module Rspec
+  module Generators
+    class FormGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
+
+      def create_test_file
+        template 'form_spec.rb.tt', File.join('spec/forms', class_path, "#{file_name}_form_spec.rb")
+      end
+
+      private
+
+        def file_name
+          @_file_name ||= remove_possible_suffix(super)
+        end
+
+        def remove_possible_suffix(name)
+          name.sub(/_?form$/i, "")
+        end
+    end
+  end
+end

data/lib/generators/rspec/poro_generator.rb

@@ -0,0 +1,11 @@
+module Rspec
+  module Generators
+    class PoroGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
+
+      def create_test_file
+        template 'model_spec.rb.tt', File.join('spec/models', class_path, "#{file_name}_spec.rb")
+      end
+    end
+  end
+end

data/lib/generators/rspec/service_generator.rb

@@ -0,0 +1,21 @@
+module Rspec
+  module Generators
+    class ServiceGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
+
+      def create_test_file
+        template 'service_spec.rb.tt', File.join('spec/services', class_path, "#{file_name}_service_spec.rb")
+      end
+
+      private
+
+        def file_name
+          @_file_name ||= remove_possible_suffix(super)
+        end
+
+        def remove_possible_suffix(name)
+          name.sub(/_?service$/i, "")
+        end
+    end
+  end
+end

data/lib/generators/rspec/templates/form_spec.rb.tt

@@ -0,0 +1,5 @@
+require 'rails_helper'
+
+RSpec.describe <%= class_name %>Form, type: :model do
+  pending "add some examples to (or delete) #{__FILE__}"
+end

data/lib/generators/rspec/templates/model_spec.rb.tt

@@ -0,0 +1,5 @@
+require 'rails_helper'
+
+RSpec.describe <%= class_name %>, type: :model do
+  pending "add some examples to (or delete) #{__FILE__}"
+end

data/lib/generators/rspec/templates/service_spec.rb.tt

@@ -0,0 +1,5 @@
+require 'rails_helper'
+
+RSpec.describe <%= class_name %>Service, type: :model do
+  pending "add some examples to (or delete) #{__FILE__}"
+end

data/lib/generators/test_unit/form_generator.rb

@@ -0,0 +1,22 @@
+module TestUnit
+  module Generators
+    class FormGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
+      check_class_collision suffix: "FormTest"
+
+      def create_test_file
+        template 'form_test.rb.tt', File.join('test/forms', class_path, "#{file_name}_form_test.rb")
+      end
+
+      private
+
+        def file_name
+          @_file_name ||= remove_possible_suffix(super)
+        end
+
+        def remove_possible_suffix(name)
+          name.sub(/_?form$/i, "")
+        end
+    end
+  end
+end

data/lib/generators/test_unit/poro_generator.rb

@@ -0,0 +1,12 @@
+module TestUnit
+  module Generators
+    class PoroGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
+      check_class_collision suffix: "Test"
+
+      def create_test_file
+        template 'model_test.rb.tt', File.join('test/models', class_path, "#{file_name}_test.rb")
+      end
+    end
+  end
+end

data/lib/generators/test_unit/service_generator.rb

@@ -0,0 +1,22 @@
+module TestUnit
+  module Generators
+    class ServiceGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
+      check_class_collision suffix: "ServiceTest"
+
+      def create_test_file
+        template 'service_test.rb.tt', File.join('test/services', class_path, "#{file_name}_service_test.rb")
+      end
+
+      private
+
+        def file_name
+          @_file_name ||= remove_possible_suffix(super)
+        end
+
+        def remove_possible_suffix(name)
+          name.sub(/_?service$/i, "")
+        end
+    end
+  end
+end

data/lib/generators/test_unit/templates/form_test.rb.tt

@@ -0,0 +1,9 @@
+require 'test_helper'
+
+<% module_namespacing do -%>
+class <%= class_name %>FormTest < ActiveSupport::TestCase
+  # test "the truth" do
+  #   assert true
+  # end
+end
+<% end -%>

data/lib/generators/test_unit/templates/model_test.rb.tt

@@ -0,0 +1,9 @@
+require 'test_helper'
+
+<% module_namespacing do -%>
+class <%= class_name %>Test < ActiveSupport::TestCase
+  # test "the truth" do
+  #   assert true
+  # end
+end
+<% end -%>

data/lib/generators/test_unit/templates/service_test.rb.tt

@@ -0,0 +1,9 @@
+require 'test_helper'
+
+<% module_namespacing do -%>
+class <%= class_name %>ServiceTest < ActiveSupport::TestCase
+  # test "the truth" do
+  #   assert true
+  # end
+end
+<% end -%>

data/poro-rails.gemspec

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("./lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |s|
+  s.name          = 'poro-rails'
+  s.version       = '0.1.0'
+  s.authors       = ['Yoshiyuki Hirano']
+  s.email         = ['yhirano@me.com']
+  s.homepage      = 'https://github.com/yhirano55/poro-rails'
+  s.summary       = %(Simple Rails Generators for Plain Old Ruby Object, Form Object, and Service Object)
+  s.description   = %(This gem provides generators of Plain Old Ruby Object, Form Object, and Service Object for Ruby on Rails.)
+  s.license       = 'MIT'
+  s.files         = Dir.chdir(File.expand_path('.', __dir__)) do
+    `git ls-files -z`.split("\x0")
+  end
+  s.require_paths = ['lib']
+
+  s.required_ruby_version = '>= 2.2.2'
+  s.required_rubygems_version = '>= 1.8.11'
+
+  s.add_development_dependency 'bundler', '~> 2.0'
+  s.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: poro-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yoshiyuki Hirano
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: This gem provides generators of Plain Old Ruby Object, Form Object, and
+  Service Object for Ruby on Rails.
+email:
+- yhirano@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/poro/form/USAGE
+- lib/generators/poro/form/form_generator.rb
+- lib/generators/poro/form/templates/form.rb.tt
+- lib/generators/poro/service/USAGE
+- lib/generators/poro/service/service_generator.rb
+- lib/generators/poro/service/templates/service.rb.tt
+- lib/generators/rails/USAGE
+- lib/generators/rails/poro_generator.rb
+- lib/generators/rails/templates/model.rb.tt
+- lib/generators/rspec/form_generator.rb
+- lib/generators/rspec/poro_generator.rb
+- lib/generators/rspec/service_generator.rb
+- lib/generators/rspec/templates/form_spec.rb.tt
+- lib/generators/rspec/templates/model_spec.rb.tt
+- lib/generators/rspec/templates/service_spec.rb.tt
+- lib/generators/test_unit/form_generator.rb
+- lib/generators/test_unit/poro_generator.rb
+- lib/generators/test_unit/service_generator.rb
+- lib/generators/test_unit/templates/form_test.rb.tt
+- lib/generators/test_unit/templates/model_test.rb.tt
+- lib/generators/test_unit/templates/service_test.rb.tt
+- poro-rails.gemspec
+homepage: https://github.com/yhirano55/poro-rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.8.11
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Simple Rails Generators for Plain Old Ruby Object, Form Object, and Service
+  Object
+test_files: []