concerning 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 454efdfc441f4945f845b6c1d73cbd5359c1d921
-  data.tar.gz: 1fb3b505754eed97217ae9661d152bec8ab2a674
+  metadata.gz: 46300e9d1f6336b137f30a7ce604b609af70949b
+  data.tar.gz: 5af204914956c879ab923da970083186eed8ea5a
 SHA512:
-  metadata.gz: e8d1462bf277d70644c760e45947e76813bcea4f76ad7828959d4bf55ff75787ffa90cc0dfb283618ae4a32c8ea3ad6427b2ac4cb3cfd5588d773dad76a74fae
-  data.tar.gz: b0726d7cfdb19e3f0b1febc8dcbac4ffb3dc96a622fb31abd27a82ccc289402473a55b54b560309dbdffc675a38fb65ebc4e10d7231531c5fd5ecea3cfbcf506
+  metadata.gz: 8134f6abaf203e3d1d3e8397ceb14e2868307a07051f0f5dbffb6f72c7f32997537b5ff39361ef58b6aaf180a2039c3166d1967dd410149f5cabea568bfe28b9
+  data.tar.gz: 99bd868353c2e2d28e5f2b7c22ef2f4c03da6dafd5fbfb58b63325640a0ef61fcaf3005784b2a7eff4b1b27fb6f1ce9f83341320fea565f10c23afb1e8462dd3

data/lib/concerning.rb

@@ -8,5 +8,5 @@
 begin
   require 'active_support/core_ext/module/concerning'
 rescue LoadError
-  require 'concerning/module_extension'
+  require 'concerning/extension'
 end

data/lib/concerning/{module_extension.rb → extension.rb}

@@ -1,3 +1,5 @@
+require 'active_support/concern'
+
 class Module
   # We often find ourselves with a medium-sized chunk of behavior that we'd
   # like to extract, but only mix in to a single class.
@@ -113,35 +115,41 @@ class Module
   # * clean up junk drawer classes by encapsulating their concerns
   # * stop leaning on protected/private for "internal stuff" modularity
   module Concerning
-    # Define a new concern and mix it in.
     def concerning(topic, &block)
       include concern(topic, &block)
     end
+  end
+  include Concerning # We do this mixin just for nice RDoc.
+end
 
-    # Add class methods via the concern.
-    def class_methods(&block)
-      const_set :ClassMethods, Module.new(&block)
-    end
+module Kernel
+  # A low-cruft shortcut to define a concern.
+  #
+  #   concern :EventTracking do
+  #     ...
+  #   end
+  #
+  #   module EventTracking
+  #     extend ActiveSupport::Concern
+  #
+  #     ...
+  #   end
+  def concern(topic, &module_definition)
+    const_set topic, Module.new {
+      extend ActiveSupport::Concern
+      module_eval(&module_definition)
+    }
+  end
+end
 
-    # A low-cruft shortcut to define a concern.
-    #
-    #   concern :EventTracking do
-    #     ...
-    #   end
-    #
-    #   module EventTracking
-    #     extend ActiveSupport::Concern
-    #
-    #     ...
-    #   end
-    def concern(topic, &module_definition)
-      require 'active_support/concern'
+# Provide a class_methods alternative to ClassMethods since defining
+# a constant within a block doesn't work as folks would expect.
+ActiveSupport::Concern.module_eval do
+  def class_methods(&class_methods_module_definition)
+    mod = const_defined?(:ClassMethods) ?
+      const_get(:ClassMethods) :
+      const_set(:ClassMethods, Module.new)
 
-      const_set topic, Module.new {
-        extend ActiveSupport::Concern
-        module_eval(&module_definition)
-      }
-    end
-  end
-  include Concerning
+    mod.module_eval(&class_methods_module_definition)
+  end unless method_defined? :class_methods
 end

data/test/active_support_stub/active_support/core_ext/module/concerning.rb

@@ -0,0 +1 @@
+CONCERNING_DEFERRED_TO_ACTIVE_SUPPORT = true

data/test/concerning_test.rb

@@ -0,0 +1,100 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'minitest/autorun'
+$VERBOSE = true
+
+require 'concerning'
+
+class ConcerningTest < Minitest::Test
+  def test_concerning_declares_a_concern_and_includes_it_immediately
+    klass = Class.new { concerning(:Foo) { } }
+    assert klass.ancestors.include?(klass::Foo), klass.ancestors.inspect
+  end
+end
+
+class ConcernTest < Minitest::Test
+  def test_concern_creates_a_module_extended_with_active_support_concern
+    klass = Class.new do
+      concern :Foo do
+        included { @foo = 1 }
+        def should_be_public; end
+      end
+    end
+
+    # Declares a concern but doesn't include it
+    assert_kind_of ActiveSupport::Concern, klass::Foo
+    assert !klass.ancestors.include?(klass::Foo), klass.ancestors.inspect
+
+    # Public method visibility by default
+    assert klass::Foo.public_instance_methods.map(&:to_s).include?('should_be_public')
+
+    # Calls included hook
+    assert_equal 1, Class.new { include klass::Foo }.instance_variable_get('@foo')
+  end
+
+  def test_may_be_defined_at_toplevel
+    mod = Kernel.concern(:Foo) { }
+    assert_equal mod, ::Foo
+    assert_kind_of ActiveSupport::Concern, ::Foo
+    assert !Object.ancestors.include?(::Foo), mod.ancestors.inspect
+  end
+
+  class Foo
+    concerning :Bar do
+      module ClassMethods
+        def will_be_orphaned; end
+      end
+
+      const_set :ClassMethods, Module.new {
+        def hacked_on; end
+      }
+
+      # Doesn't overwrite existing ClassMethods module.
+      class_methods do
+        def nicer_dsl; end
+      end
+
+      # Doesn't overwrite previous class_methods definitions.
+      class_methods do
+        def doesnt_clobber; end
+      end
+    end
+  end
+
+  def test_using_class_methods_blocks_instead_of_ClassMethods_module
+    assert !Foo.respond_to?(:will_be_orphaned)
+    assert Foo.respond_to?(:hacked_on)
+    assert Foo.respond_to?(:nicer_dsl)
+    assert Foo.respond_to?(:doesnt_clobber)
+
+    # Orphan in Foo::ClassMethods, not Bar::ClassMethods.
+    assert Foo.const_defined?(:ClassMethods)
+    assert Foo::ClassMethods.method_defined?(:will_be_orphaned)
+  end
+end
+
+# Put a fake Active Support implementation in the load path to verify that
+# we defer to it when we can.
+class ForwardCompatibilityWithRails41Test < Minitest::Test
+  def setup;    expunge_loaded_features end
+  def teardown; expunge_loaded_features end
+
+  def test_check_for_active_support_implementation_before_providing_our_own
+    with_stubbed_active_support_in_load_path do
+      require 'concerning'
+    end
+    assert defined?(::CONCERNING_DEFERRED_TO_ACTIVE_SUPPORT)
+  end
+
+  private
+  def expunge_loaded_features
+    $LOADED_FEATURES.delete_if { |feature| feature =~ /concerning/ }
+  end
+
+  def with_stubbed_active_support_in_load_path
+    $LOAD_PATH.unshift File.expand_path('../active_support_stub', __FILE__)
+    yield
+  ensure
+    $LOAD_PATH.shift
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: concerning
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Jeremy Kemper
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-19 00:00:00.000000000 Z
+date: 2014-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -28,24 +28,26 @@ dependencies:
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.1'
 description: 
 email: jeremy@basecamp.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ./lib/concerning/module_extension.rb
+- ./lib/concerning/extension.rb
 - ./lib/concerning.rb
+- ./test/active_support_stub/active_support/core_ext/module/concerning.rb
+- ./test/concerning_test.rb
 homepage: https://github.com/basecamp/concerning
 licenses:
 - MIT
@@ -70,4 +72,6 @@ rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: Separating small concerns
-test_files: []
+test_files:
+- ./test/active_support_stub/active_support/core_ext/module/concerning.rb
+- ./test/concerning_test.rb