chanko 2.3.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b169eda16ebf38c4052c3379205412a4262230db439066cf5743717797ffb120
-  data.tar.gz: 27f319ef0ec3012764d0aff3da7e55a940f3954374727c7fe430a8f7ef859bc8
+  metadata.gz: 72b1ce54ea0cf5bbf3d56237723d00c9383213d67534c21531ed568465d95435
+  data.tar.gz: 74c763b3087ac11d7ddaa4700995240681ceafd6fcfa1dcf26785d547a20e934
 SHA512:
-  metadata.gz: 349b4df82abc58b345591e783dfca68444e41d001334e701d9ae8fe227040c04b37c81b76997dd624a964ccf363c75860bd70de8f7fa7a9d33acd0afe60ec263
-  data.tar.gz: a9ee4a5cd9a3a5193ee4a3a4e597796fe0c214101bcaea094e2d5c8c60d7527ab0d54cebd9ae9a804c009d9ceaff0de73e06fabc77b452323133b2e935d4dd7d
+  metadata.gz: ec921fb9b47ca4f5878f902a01de61a8e5c96d4f671a1a3f991c3d047f2102c24245697a27e05e0af928acaa7b5345bf8cd79465082a3aabffaf2e66f26a7d68
+  data.tar.gz: a6f855b9f756b034f9098718bc1ad2c0e112f5ad0a616ac2a9023767ba92228c4f41a6cb0e1a21bf53910140dc2a8bf1480180a6aec0b1cbe8b75dd829be7d47

data/.github/workflows/master_and_pr.yml

@@ -10,45 +10,21 @@ jobs:
     strategy:
       matrix:
         rails_version:
-          - "5.0"
-          - "5.1"
-          - "5.2"
-          - "6.0"
           - "6.1"
+          - "7.0"
+          - "7.1"
         ruby_version:
-          - "2.7"
           - "3.1"
-        autoloader:
-          - "zeitwerk"
-          - "classic"
+          - "3.2"
+          - "3.3"
         eager_load:
           - "true"
           - "false"
-        exclude:
-          - rails_version: "5.0"
-            ruby_version: "3.1"
-          - rails_version: "5.1"
-            ruby_version: "3.1"
-          - rails_version: "5.2"
-            ruby_version: "3.1"
-          - rails_version: "5.0"
-            autoloader: "zeitwerk"
-          - rails_version: "5.1"
-            autoloader: "zeitwerk"
-          - rails_version: "5.2"
-            autoloader: "zeitwerk"
-          - rails_version: "5.0"
-            autoloader: "classic"
-          - rails_version: "5.1"
-            autoloader: "classic"
-          - rails_version: "5.2"
-            autoloader: "classic"
-    name: Test on Rails ${{ matrix.rails_version }} & Ruby ${{ matrix.ruby_version }} & Autoloader ${{ matrix.autoloader }} & EagerLoad ${{ matrix.eager_load }}
+    name: Test on Rails ${{ matrix.rails_version }} & Ruby ${{ matrix.ruby_version }} & EagerLoad ${{ matrix.eager_load }}
     env:
       BUNDLE_GEMFILE: gemfiles/Gemfile_rails_${{ matrix.rails_version }}.rb
       CI: true
       EAGER_LOAD: ${{ matrix.eager_load }}
-      AUTOLOADER : ${{ matrix.autoloader }}
     steps:
       - uses: actions/checkout@v3
       - uses: ruby/setup-ruby@v1
@@ -58,7 +34,7 @@ jobs:
       - name: rspec
         run: bundle exec rspec
       - name: Coveralls
-        if: matrix.rails_version == '6.1' && matrix.ruby_version == '3.1'
+        if: matrix.rails_version == '7.1' && matrix.ruby_version == '3.3'
         uses: coverallsapp/github-action@master
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}

data/.gitignore

@@ -8,7 +8,7 @@ spec/dummy/.sass-cache
 .bundle
 .config
 .yardoc
-Gemfile.lock
+gemfiles/Gemfile_rails_*.rb.lock
 InstalledFiles
 _yardoc
 coverage

data/CHANGELOG.md

@@ -1,4 +1,11 @@
-## Unreleased
+## 3.0.0
+* Support Rails 6,1. 7.0, 7.1.
+* Support Ruby >= 3.0.
+* Drop support for Rails <= 6.0.
+* Drop support for Ruby 2.
+* Drop support for classic loader.
+* The functionality to extend the view_paths has been discontinued.
+* The functionality to extend the models has been discontinued.
 
 ## 2.3.0
 * Support Rails 5.0, 5.1, 5,2, 6.0, 6,1.

data/README.md

@@ -10,11 +10,9 @@ With Chanko, you can release many features concurrently and manage target users
 When any errors are raised from chanko's features,
 it will be automatically hidden and fallback to its normal behavior.
 
-
 ## Requirements
-* Ruby >= 2.6.0
-* Rails >= 5.0.0
-
+* Ruby >= 3.0.0
+* Rails >= 6.1.0
 
 ## Usage
 Add to your Gemfile.
@@ -63,11 +61,6 @@ end
 = invoke(:example_unit, :render_example)
 ```
 
-```
--# app/units/example_unit/views/_example.html.slim
-= foo
-```
-
 ## Unit
 You can see [the real example of an unit module file](https://github.com/cookpad/chanko/blob/master/spec/dummy/app/units/entry_deletion/entry_deletion.rb).
 
@@ -120,39 +113,7 @@ end
 ```
 
 ### render
-The view path app/units/example_unit/views is added into view_paths in invoking.
-So you can render app/units/example_unit/views/_example.html.slim in invoking.
-
-```ruby
-scope(:view) do
-  function(:render_example) do
-    render "/example", :foo => hello("world")
-  end
-end
-```
-
-### models
-In models block, you can expand model features by `expand` method.
-The expanded methods are available via unit proxy like `User.unit.active`,
-`User.find(params[:id]).unit.active?` or `User.unit.gc_all_soft_deleted_users`.
-
-```ruby
-models do
-  expand(:User) do
-    scope :active, lambda { where(:deleted_at => nil) }
-
-    def active?
-      deleted_at.nil?
-    end
-
-    class_methods do
-      def gc_all_soft_deleted_users
-        where.not(deleted_at: nil).delete_all
-      end
-    end
-  end
-end
-```
+In version 2 and earlier, Chanko extended Rails' search path to include the views path of the unit. This functionality has been discontinued. To maintain the views path under the unit, you will need to manually create a symbolic link in app/views/units to access it.
 
 ### shared
 You can call methods defined by `shared` in invoking.
@@ -174,7 +135,6 @@ helpers do
 end
 ```
 
-
 ## Example
 https://github.com/cookpad/chanko/tree/master/spec/dummy  
 Chanko provides an example rails application in spec/dummy directory.

data/chanko.gemspec

@@ -12,12 +12,11 @@ Gem::Specification.new do |gem|
   gem.homepage      = "https://github.com/cookpad/chanko"
 
   gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
-  gem.required_ruby_version = '>= 2.6.0'
+  gem.required_ruby_version = '>= 3.0.0'
 
-  gem.add_dependency "rails", ">= 5.0.0"
+  gem.add_dependency "rails", ">= 6.1.0"
   gem.add_development_dependency "byebug"
   gem.add_development_dependency "coffee-rails", ">= 3.0.10"
   gem.add_development_dependency "jquery-rails"
@@ -28,7 +27,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "simplecov"
   gem.add_development_dependency 'simplecov-lcov'
   gem.add_development_dependency "slim"
-  gem.add_development_dependency "sqlite3"
+  gem.add_development_dependency "sqlite3", ">= 1.4"
   gem.add_development_dependency "thin"
   gem.add_development_dependency "uglifier"
 end

data/gemfiles/Gemfile_rails_6.1.rb

@@ -1,8 +1,6 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 gemspec path: '..'
 
 gem 'rails', '~> 6.1.0'
-gem 'net-smtp'
-gem 'net-pop'
-gem 'net-imap'
+gem 'sqlite3', '~> 1.4'

data/gemfiles/Gemfile_rails_7.0.rb

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec path: '..'
+
+gem 'rails', '~> 7.0.0'
+gem 'sqlite3', '~> 1.4'

data/gemfiles/Gemfile_rails_7.1.rb

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec path: '..'
+
+gem 'rails', '~> 7.1.0'
+gem 'sqlite3', '~> 1.4'

data/lib/chanko/function.rb

@@ -22,12 +22,10 @@ module Chanko
 
     def invoke(context, options = {})
       with_unit_stack(context) do
-        with_unit_view_path(context) do
-          capture_exception(context) do
-            result = context.instance_eval(&block)
-            result = decorate(result, context, options[:type]) if context.view? && result.present?
-            result
-          end
+        capture_exception(context) do
+          result = context.instance_eval(&block)
+          result = decorate(result, context, options[:type]) if context.view? && result.present?
+          result
         end
       end
     end
@@ -59,13 +57,6 @@ module Chanko
       context.units.pop
     end
 
-    def with_unit_view_path(context)
-      context.view_paths.unshift unit.resolver if context.respond_to?(:view_paths)
-      yield
-    ensure
-      context.view_paths.paths.shift if context.respond_to?(:view_paths)
-    end
-
     def capture_exception(context)
       yield
     rescue Exception => exception

data/lib/chanko/railtie.rb

@@ -7,11 +7,6 @@ module Chanko
       ActiveSupport.on_load :action_controller do
         ::ActionController::Base.send(:include, Controller, Invoker, UnitProxyProvider)
       end
-      ActiveSupport.on_load :active_record do
-        ::ActiveRecord::Base.send(:include, UnitProxyProvider)
-        ::ActiveRecord::Relation.send(:include, UnitProxyProvider)
-        ::ActiveRecord::Associations::CollectionAssociation.send(:include, UnitProxyProvider)
-      end
     end
 
 
@@ -21,14 +16,6 @@ module Chanko
       Chanko::Loader.prepare_eager_load(mode: :zeitwerk)
     end
 
-    initializer("chanko.classic.prepare_eager_load", after: :load_environment_config) do |app|
-      # Rails5 doens't load environments/*.rb files before :set_autoload_paths.
-      # In other words, at this stage, config.eager_load cannot be determined to be true or false.
-      # But classic loader does not freeze paths on :set_autoload_paths.
-      # After all, It's ok if it is executed after :set_autoload_paths on Rails5 and Rails6(classic).
-      Chanko::Loader.prepare_eager_load(mode: :classic)
-    end
-
     initializer("chanko.eager_load_units", before: :eager_load!) do |app|
       # This is why we need handmade eager-loading
       # https://github.com/cookpad/chanko/pull/38

data/lib/chanko/unit/extender/extension.rb

@@ -2,8 +2,6 @@ module Chanko
   module Unit
     class Extender
       class Extension < Module
-        include ActiveRecordClassMethods
-
         def initialize(mod, prefix = nil, &block)
           @mod    = mod
           @prefix = prefix

data/lib/chanko/unit/extender.rb

@@ -1,4 +1,3 @@
-require "chanko/unit/extender/active_record_class_methods"
 require "chanko/unit/extender/extension"
 
 module Chanko

data/lib/chanko/unit.rb

@@ -33,10 +33,6 @@ module Chanko
         Helper.define(unit_name, &block)
       end
 
-      def models(&block)
-        extender.instance_eval(&block)
-      end
-
       def active_if(*conditions, &block)
         @active_if = ActiveIf.new(*conditions, &block)
       end
@@ -70,10 +66,6 @@ module Chanko
         UnitProxy.generate_prefix(unit_name)
       end
 
-      def view_path
-        Rails.root.join("#{Config.units_directory_path}/#{unit_name}/views").to_s
-      end
-
       def find_function(identifier, label)
         scope     = ScopeFinder.find(identifier)
         target    = scope.ancestors.find {|klass| scopes[klass] }
@@ -93,10 +85,6 @@ module Chanko
         @shared_methods ||= {}
       end
 
-      def resolver
-        @resolver ||= Config.resolver.new(view_path)
-      end
-
       def extender
         @extender ||= Extender.new(to_prefix)
       end

data/lib/chanko/version.rb

@@ -1,3 +1,3 @@
 module Chanko
-  VERSION = "2.3.0"
+  VERSION = "3.0.0"
 end

data/lib/generators/chanko/unit/templates/unit.rb.erb

@@ -14,7 +14,7 @@ module <%= class_name %>
   # ```
 
   # ## raise_error
-  # `raise_error` is used to force an unit to raise up errors occured in invoking.
+  # `raise_error` is used to force an unit to raise up errors occurred in invoking.
   # You can force to raise up errors also by `Config.raise_error`.
   #
   # ```
@@ -34,36 +34,11 @@ module <%= class_name %>
   # ```
 
   # ## render
-  # In addition, the view path "<%= "#{directory}/views" %>" is added into view_paths.
-  # So you can render <%= "#{directory}/views/_example.html.erb" %> in invoking.
-  #
+  # If you want to place the views path under the unit, create a symbolic link under app/views/units and refer to it.
   # ```
   # scope(:view) do
   #   function(:function_name) do
-  #     render "/example", :foo => "bar"
-  #   end
-  # end
-  # ```
-
-  # ## models
-  # In models block, you can expand model features by `expand` method.
-  # The expanded methods are available via unit proxy like `User.unit.active`,
-  # `User.find(params[:id]).unit.active?` or `User.unit.gc_all_soft_deleted_users`.
-  #
-  # ```
-  # models do
-  #   expand(:User) do
-  #     scope :active, lambda { where(:deleted_at => nil) }
-  #
-  #     def active?
-  #       deleted_at.nil?
-  #     end
-  #
-  #     class_methods do
-  #       def gc_all_soft_deleted_users
-  #         where.not(deleted_at: nil).delete_all
-  #       end
-  #     end
+  #     render "/units/<%= file_name.underscore %>/example", :foo => "bar"
   #   end
   # end
   # ```

data/lib/generators/chanko/unit/unit_generator.rb

@@ -6,44 +6,53 @@ module Chanko
       source_root File.expand_path("../templates", __FILE__)
 
       def create_unit_directory
-        empty_directory(directory)
+        empty_directory(unit_directory)
       end
 
       def create_unit_file
-        template("unit.rb.erb", "#{directory}/#{file_name}.rb")
+        template("unit.rb.erb", "#{unit_directory}/#{file_name}.rb")
       end
 
-      def create_views_directory
-        create_file("#{directory}/views/.gitkeep", "")
+      def create_views_unit_directory
+        create_file("#{unit_directory}/views/.gitkeep", "")
       end
 
       ASSETS_TYPES.each do |type|
-        define_method("create_#{type}_directory") do
-          create_file("#{directory}/#{type}/.gitkeep", "")
+        define_method("create_#{type}_unit_directory") do
+          create_file("#{unit_directory}/#{type}/.gitkeep", "")
         end
-      end
 
-      ASSETS_TYPES.each do |type|
-        define_method("create_#{type}_symlink") do
+        define_method("create_#{type}_unit_symlink") do
           create_assets_symlink(type)
         end
       end
 
+      def create_views_symlink
+        from = "app/views/#{units_directory_name}/#{file_name}"
+        to   = "../../../#{relative_unit_directory}/views"
+        create_link(from, to)
+      end
+
       private
 
       def create_assets_symlink(type)
-        from = "app/assets/#{type}/#{directory_name}/#{file_name}"
-        to   = "../../../../#{directory}/#{type}"
+        from = "app/assets/#{type}/#{units_directory_name}/#{file_name}"
+        to   = "../../../../#{relative_unit_directory}/#{type}"
         create_link(from, to)
       end
 
-      def directory
+      def relative_unit_directory
+        Pathname.new(unit_directory).relative_path_from(Rails.root)
+      end
+
+      def unit_directory
         "#{Chanko::Config.units_directory_path}/#{file_name}"
       end
 
-      def directory_name
+      def units_directory_name
         Chanko::Config.units_directory_path.split("/").last
       end
     end
   end
 end
+

data/spec/chanko/function_spec.rb

@@ -6,24 +6,7 @@ module Chanko
       Loader.load(:example_unit)
     end
 
-    def rails5_action_view_instance
-      klass = Class.new(ActionView::Base) do
-        def current_unit
-          units.last
-        end
-
-        def units
-          @units ||= []
-        end
-
-        def path
-          view_paths.first.to_s
-        end
-      end
-      klass.new
-    end
-
-    def rails6_action_view_instance
+    def action_view_instance
       klass = Class.new(ActionView::Base.with_empty_template_cache) do
         def current_unit
           units.last
@@ -32,32 +15,12 @@ module Chanko
         def units
           @units ||= []
         end
-
-        def path
-          view_paths.first.to_s
-        end
       end
-
       klass.with_view_paths([], {}, nil)
     end
 
     let(:context) do
-      case Rails::VERSION::MAJOR
-      when 5
-        rails5_action_view_instance
-      when 6
-        rails6_action_view_instance
-      end
-    end
-
-    let(:context_without_view_paths) do
-      Class.new do
-        include Chanko::Invoker
-
-        def units
-          @units ||= []
-        end
-      end.new
+      action_view_instance
     end
 
     let(:options) do
@@ -68,19 +31,6 @@ module Chanko
       it "invokes block with given context and stacked unit" do
         expect(described_class.new(unit, :label) { current_unit }.invoke(context, options)).to eq(unit)
       end
-
-      context "when context is a view" do
-        it "invokes with unit's view path" do
-          expect(described_class.new(unit, :label) { path }.invoke(context, options)).to eq(unit.view_path)
-        end
-      end
-
-      context "when context does not have view_paths" do
-        it "invokes successfully" do
-          expect(described_class.new(unit, :label) { "test" }.
-            invoke(context_without_view_paths, options)).to eq("test")
-        end
-      end
     end
   end
 end

data/spec/chanko/test_spec.rb

@@ -3,24 +3,11 @@ require "chanko/test"
 
 module Chanko
   describe Test do
-    def rails5_action_view_instance
-      Class.new(ActionView::Base).new
-    end
-
-    def rails6_action_view_instance
+    let(:view) do
       klass = Class.new(ActionView::Base.with_empty_template_cache)
       klass.with_view_paths(nil, {}, nil)
     end
 
-    let(:view) do
-      case Rails::VERSION::MAJOR
-      when 5
-        rails5_action_view_instance
-      when 6
-        rails6_action_view_instance
-      end
-    end
-
     describe "#enable_unit" do
       it "forces to enable specified unit" do
         enable_unit(:inactive_unit)

data/spec/chanko/unit_spec.rb

@@ -188,68 +188,5 @@ module Chanko
         expect(view.__example_unit_test).to eq("test")
       end
     end
-
-    describe ".models" do
-      before do
-        stub_const("ExampleModel", model_class)
-        unit.models do
-          expand(:ExampleModel) do
-            scope :active, lambda { where(:deleted_at => nil) }
-
-            has_one :user
-
-            def test
-              "test"
-            end
-
-            class_methods do
-              def test
-                "test"
-              end
-            end
-          end
-        end
-      end
-
-      let(:model_class) do
-        Class.new do
-          include UnitProxyProvider
-
-          def self.scope(name, *args)
-            singleton_class.class_eval do
-              define_method(name) { "scoped" }
-            end
-          end
-
-          def self.has_one(name, *args)
-            singleton_class.class_eval do
-              define_method(name) { args }
-            end
-          end
-        end
-      end
-
-      it "defines instance methods with prefix" do
-        expect(ExampleModel.new.__example_unit_test).to eq("test")
-      end
-
-      it "defines class methods with prefix" do
-        expect(ExampleModel.__example_unit_test).to eq("test")
-      end
-
-      it "defines scope method with prefix" do
-        expect(ExampleModel.__example_unit_active).to eq("scoped")
-      end
-
-      it "defines has_one association method with prefix" do
-        expect(ExampleModel.__example_unit_user).to eq([:class_name => "User"])
-      end
-    end
-
-    describe ".view_path" do
-      it "returns path for its view directory" do
-        expect(unit.view_path).to eq("#{Config.units_directory_path}/example_unit/views")
-      end
-    end
   end
 end

data/spec/dummy/app/units/entry_deletion/entry_deletion.rb

@@ -19,22 +19,6 @@ module EntryDeletion
     end
   end
 
-  models do
-    expand(:Entry) do
-      scope :active, lambda { where(:deleted_at => nil) }
-
-      def soft_delete
-        update_attributes(:deleted_at => Time.now)
-      end
-
-      class_methods do
-        def gc_all_soft_deleted_users
-          where.not(deleted_at: nil).delete_all
-        end
-      end
-    end
-  end
-
   helpers do
     def link_to_deletion(entry)
       link_to "Delete", entry, :method => :delete

data/spec/dummy/app/views/units/example_unit

@@ -0,0 +1 @@
+../../../../fixtures/units/example_unit/views