pattern_generator 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6c6688fe0b90f8cf237c4e6c2a18268e1f77bede
-  data.tar.gz: 74710dcaf305ebad7f61c53634b2fc0c0432fc0c
+  metadata.gz: 7ea1fb8d728c10d64b9cb86e82ce3b1a983148ed
+  data.tar.gz: 8ee5f1ebe85f20c7db9314c2904eb26eb8d23e79
 SHA512:
-  metadata.gz: ab019869856924be0d44a22a38f9a3bd5aef2e4897e11d584603f7c0e46e7c51e9bb20f211d34733840f80532e678ce2ca49e7b5c596b615c7ee3c7a6dade1ef
-  data.tar.gz: f9fad96993b444f6e7fad67d63a2b27c4cd67b9325f93b28a7c605aa9742334dc6647da10a1a1f1dfa72ec24e48e79e7f55ed18da8b656734ef902af6b77e901
+  metadata.gz: 54b325aa4025cb188bbf13b2d4824e2ff404c2551cb5c08c17f0b4b8d1e68d28a3c057bbdad0b01b6aad459e718d03d70811a3f63f5580b2a58ed05b53d63d02
+  data.tar.gz: 500ad4871f906f37a3ca41bf7ed0b9e35ac5cb87779a32dd871ca6c145e53a914fcc60e2356a653d029af873ccdbea26f9b416922ac5b8f0d33ab4bc6bde1a24

data/lib/generators/base_generator.rb

@@ -0,0 +1,59 @@
+require "active_support/inflector"
+
+# Base class for all generators to come. If you want to override some behaviour, all you
+# got to do is override a method in the child class.
+class BaseGenerator < Rails::Generators::NamedBase
+  class_option :rspec, type: :boolean, desc: 'DEFAULT: Define rspec as your test framework.'
+  class_option :minitest, type: :boolean, desc: 'Test framework to generate test. (rspec or minitest)'
+  class_option :no_suffix, type: :boolean, desc: "If you don't want any pattern suffix. Ex: AuthenticationService. Service is the suffix."
+
+  # Creates the file for the requested pattern based on a template file.
+  def copy_pattern_file
+    template "#{pattern_name}.rb", generated_file_path
+  end
+
+  # Creates the test file for the request pattern based on a template file.
+  def copy_pattern_test_file
+    template "#{pattern_name}_#{test_suite_identifier}.rb", generated_test_file_path
+  end
+
+  private
+
+  # Determines the class name based on the file name given by the user.
+  def class_name
+    file_name.classify + suffix.classify
+  end
+
+  # This method must be overrided in the child classes.
+  def pattern_name
+    raise NotImplementedError
+  end
+
+  def folder_name
+    pattern_name.pluralize
+  end
+
+  # Generates the pattern suffix.
+  # Ex: _service
+  def suffix
+    options.no_suffix? ? "" : "_#{pattern_name}"
+  end
+
+  # Generates the file path.
+  # Ex: app/services/authentication.rb
+  def generated_file_path
+    "app/#{folder_name}/#{file_name}#{suffix}.rb"
+  end
+
+  def test_suite_identifier
+    identifier = "spec"
+    identifier = "test" if options.minitest?
+    identifier
+  end
+
+  # Generates the test file path.
+  # Ex: spec/services/authentication_spec.rb
+  def generated_test_file_path
+    "#{test_suite_identifier}/#{folder_name}/#{file_name}#{suffix}_#{test_suite_identifier}.rb"
+  end
+end

data/lib/generators/form/form_generator.rb

@@ -0,0 +1,9 @@
+class FormGenerator < BaseGenerator
+  source_root File.expand_path("../templates", __FILE__)
+
+  private
+
+  def pattern_name
+    "form"
+  end
+end

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

@@ -0,0 +1,5 @@
+class <%= class_name %>
+  def initialize
+
+  end
+end

data/lib/generators/form/templates/form_spec.rb

@@ -0,0 +1,5 @@
+require 'rails_helper'
+
+RSpec.describe <%= class_name %>, type: :form do
+  pending "Add some tests to #{__FILE__}"
+end

data/lib/generators/form/templates/form_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class <%= class_name %>Test < Minitest::Test
+  def test_call
+    
+  end
+end

data/lib/generators/policy/policy_generator.rb

@@ -1,24 +1,9 @@
-require 'active_support/inflector'
-
-class PolicyGenerator < Rails::Generators::NamedBase
+class PolicyGenerator < BaseGenerator
   source_root File.expand_path('../templates', __FILE__)
-  class_option :test_suite, type: :string, default: 'rspec', desc: 'Test framework to generate test. (rspec or minitest)'
-
-  def generate_template
-    template 'policy.rb', "app/policies/#{file_name}_policy.rb"
-  end
-
-  def generate_test
-    if options.test_suite == 'rspec'
-      template 'policy_spec.rb', "spec/policies/#{file_name}_policy_spec.rb"
-    elsif options.test_suite == 'minitest'
-      template 'policy_test.rb', "test/policies/#{file_name}_policy_test.rb"
-    end
-  end
 
   private
 
-  def class_name
-    file_name.classify
+  def pattern_name
+    "policy"
   end
 end

data/lib/generators/policy/templates/policy.rb

@@ -1,9 +1,5 @@
-class <%= class_name %>Policy
+class <%= class_name %>
   def initialize
     
   end
-
-  def policy_method
-    # Customize to fit your need
-  end
 end

data/lib/generators/policy/templates/policy_spec.rb

@@ -1,9 +1,5 @@
 require 'rails_helper'
 
-RSpec.describe <%= class_name %>Policy, type: :policy do
-  describe '#policy_method' do
-    it 'does something' do
-      
-    end
-  end
+RSpec.describe <%= class_name %>, type: :policy do
+  pending "Add some tests to #{__FILE__}"
 end

data/lib/generators/policy/templates/policy_test.rb

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class <%= class_name %>PolicyTest < Minitest::Test
+class <%= class_name %>Test < Minitest::Test
   def test_something
 
   end

data/lib/generators/poro/poro_generator.rb

@@ -1,24 +1,17 @@
-require 'active_support/inflector'
-
-class PoroGenerator < Rails::Generators::NamedBase
+class PoroGenerator < BaseGenerator
   source_root File.expand_path('../templates', __FILE__)
-  class_option :test_suite, type: :string, default: 'rspec', desc: 'Test framework to generate test. (rspec or minitest)'
 
-  def generate_template
-    template 'poro.rb', "app/models/#{file_name}.rb"
-  end
+  private
 
-  def generate_test
-    if options.test_suite == 'rspec'
-      template 'poro_spec.rb', "spec/models/#{file_name}_spec.rb"
-    elsif options.test_suite == 'minitest'
-      template 'poro_test.rb', "test/models/#{file_name}_test.rb"
-    end
+  def folder_name
+    "models"
   end
 
-  private
+  def pattern_name
+    "poro"
+  end
 
-  def class_name
-    file_name.classify
+  def suffix
+    ""
   end
 end

data/lib/generators/service/service_generator.rb

@@ -1,24 +1,9 @@
-require "active_support/inflector"
-
-class ServiceGenerator < Rails::Generators::NamedBase
+class ServiceGenerator < BaseGenerator
   source_root File.expand_path('../templates', __FILE__)
-  class_option :test_suite, type: :string, default: 'rspec', desc: 'Test framework to generate test. (rspec or minitest)'
-
-  def copy_service_file
-    template 'service.rb', "app/services/#{file_name}_service.rb"
-  end
-
-  def copy_service_test_file
-    if options.test_suite == 'rspec'
-      template 'service_spec.rb', "spec/services/#{file_name}_service_spec.rb"
-    elsif options.test_suite == 'minitest'
-      template 'service_test.rb', "test/services/#{file_name}_service_test.rb"
-    end
-  end
 
   private
 
-  def class_name
-    file_name.classify
+  def pattern_name
+    "service"
   end
 end

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

@@ -1,9 +1,5 @@
-class <%= class_name %>Service
+class <%= class_name %>
   def initialize
 
   end
-
-  def call
-
-  end
 end

data/lib/generators/service/templates/service_spec.rb

@@ -1,9 +1,5 @@
 require 'rails_helper'
 
-RSpec.describe <%= class_name %>Service, type: :service do
-  describe '#call' do
-    it 'performs something' do
-
-    end
-  end
+RSpec.describe <%= class_name %>, type: :service do
+  pending "Add some tests to #{__FILE__}"
 end

data/lib/generators/service/templates/service_test.rb

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class <%= class_name %>ServiceTest < Minitest::Test
+class <%= class_name %>Test < Minitest::Test
   def test_call
     
   end

data/lib/pattern_generator.rb

@@ -1,4 +1,10 @@
 require "rails/generators"
 
+require_relative "./generators/base_generator"
+
+%w(form policy poro service).each do |pattern|
+  require_relative "./generators/#{pattern}/#{pattern}_generator"
+end
+
 module PatternGenerator
 end

data/lib/pattern_generator/version.rb

@@ -1,3 +1,3 @@
 module PatternGenerator
-  VERSION = "0.0.4"
+  VERSION = "0.1.0"
 end

data/test/dummy/config/application.rb

@@ -20,7 +20,6 @@ module Dummy
     # config.i18n.default_locale = :de
 
     # Do not swallow errors in after_commit/after_rollback callbacks.
-    config.active_record.raise_in_transactional_callbacks = true
   end
 end
 

data/test/generators/form_generator_test.rb

@@ -0,0 +1,53 @@
+require 'test_helper'
+
+class FormGeneratorTest < Rails::Generators::TestCase
+  tests FormGenerator
+
+  destination File.join(Rails.root)
+  teardown :cleanup
+
+  def cleanup
+    FileUtils.rm_rf(File.join(Rails.root, 'app/forms'))
+    FileUtils.rm_rf(File.join(Rails.root, 'spec/forms'))
+    FileUtils.rm_rf(File.join(Rails.root, 'test/forms'))
+  end
+
+  test 'correct file is generated' do
+    run_generator %w(registration)
+
+    assert_file 'app/forms/registration_form.rb' do |content|
+      assert_match /RegistrationForm/, content
+      assert_match /def initialize/, content
+    end
+  end
+
+  test 'correct spec file is generated' do
+    run_generator %w(registration)
+
+    assert_file 'spec/forms/registration_form_spec.rb' do |content|
+      assert_match /RSpec.describe RegistrationForm, type: :form/, content
+      assert_match /pending/, content
+    end
+  end
+
+  test 'generates minitest file if --minitest options is passed' do
+    run_generator %w(registration --minitest)
+
+    assert_file 'test/forms/registration_form_test.rb' do |content|
+      assert_match /class RegistrationFormTest < Minitest::Test/, content
+    end
+  end
+
+  test 'generates files with no suffixes if --no-sufix option is passed' do
+    run_generator %w(registration --no-suffix)
+
+    assert_file 'app/forms/registration.rb' do |content|
+      assert_match /Registration/, content
+      assert_match /def initialize/, content
+    end
+
+    assert_file 'spec/forms/registration_spec.rb' do |content|
+      assert_match /RSpec.describe Registration, type: :form/, content
+    end
+  end
+end

data/test/generators/policy_generator_test.rb

@@ -1,5 +1,4 @@
 require 'test_helper'
-require 'generators/policy/policy_generator'
 
 class PolicyGeneratorTest < Rails::Generators::TestCase
   tests PolicyGenerator
@@ -19,6 +18,7 @@ class PolicyGeneratorTest < Rails::Generators::TestCase
 
     assert_file 'app/policies/active_user_policy.rb' do |content|
       assert_match /class ActiveUserPolicy/, content
+      assert_match /def initialize/, content
     end
   end
 
@@ -27,15 +27,28 @@ class PolicyGeneratorTest < Rails::Generators::TestCase
 
     assert_file 'spec/policies/active_user_policy_spec.rb' do |content|
       assert_match /RSpec.describe ActiveUserPolicy, type: :policy do/, content
+      assert_match /pending/, content
     end
   end
 
   test "if minitest is specified, minitest file is generated" do
-    run_generator %w(active_user --test-suite=minitest)
+    run_generator %w(active_user --minitest)
 
     assert_file 'test/policies/active_user_policy_test.rb' do |content|
       assert_match /class ActiveUserPolicyTest < Minitest::Test/, content
     end
   end
 
+  test 'generates files with no suffixes if --no-sufix option is passed' do
+    run_generator %w(active_user --no-suffix)
+
+    assert_file 'app/policies/active_user.rb' do |content|
+      assert_match /ActiveUser/, content
+      assert_match /def initialize/, content
+    end
+
+    assert_file 'spec/policies/active_user_spec.rb' do |content|
+      assert_match /RSpec.describe ActiveUser, type: :policy/, content
+    end
+  end
 end

data/test/generators/poro_generator_test.rb

@@ -1,5 +1,4 @@
 require 'test_helper'
-require 'generators/poro/poro_generator'
 
 class PoroGeneratorTest < Rails::Generators::TestCase
   tests PoroGenerator
@@ -31,7 +30,7 @@ class PoroGeneratorTest < Rails::Generators::TestCase
   end
 
   test 'minitest file is generated when test-suite is minitest' do
-    run_generator %w(grade --test-suite=minitest)
+    run_generator %w(grade --minitest)
 
     assert_file 'test/models/grade_test.rb' do |content|
       assert_match /class GradeTest < MiniTest::Test/, content

data/test/generators/service_generator_test.rb

@@ -1,5 +1,4 @@
 require 'test_helper'
-require 'generators/service/service_generator'
 
 class ServiceGeneratorTest < Rails::Generators::TestCase
   tests ServiceGenerator
@@ -17,8 +16,8 @@ class ServiceGeneratorTest < Rails::Generators::TestCase
     run_generator %w(find_match)
 
     assert_file 'app/services/find_match_service.rb' do |content|
-      assert_match /FindMatchService/, content
-      assert_match /def call/, content
+      assert_match /class FindMatchService/, content
+      assert_match /def initialize/, content
     end
   end
 
@@ -27,14 +26,28 @@ class ServiceGeneratorTest < Rails::Generators::TestCase
 
     assert_file 'spec/services/find_match_service_spec.rb' do |content|
       assert_match /RSpec.describe FindMatchService, type: :service/, content
+      assert_match /pending/, content
     end
   end
 
   test 'generates minitest file if test-framework is minitest' do
-    run_generator %w(find_match --test-suite=minitest)
+    run_generator %w(find_match --minitest)
 
     assert_file 'test/services/find_match_service_test.rb' do |content|
       assert_match /class FindMatchServiceTest < Minitest::Test/, content
     end
   end
+
+  test 'generates files with no suffixes if --no-sufix option is passed' do
+    run_generator %w(find_match --no-suffix)
+
+    assert_file 'app/services/find_match.rb' do |content|
+      assert_match /FindMatch/, content
+      assert_match /def initialize/, content
+    end
+
+    assert_file 'spec/services/find_match_spec.rb' do |content|
+      assert_match /RSpec.describe FindMatch, type: :service/, content
+    end
+  end
 end