internal 0.1.0alpha01 → 0.1.0.alpha2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8beaebb6456b1b31120cf25433dd056d938c0412
+  data.tar.gz: a589fef9999659ba706c8e827073afb72e0e32bd
+SHA512:
+  metadata.gz: 2b8b04f8deeabe6566294d22d431070e8367a23bb89c649eb893ff00ed53536a90f7c6180ce039ccabb685d8c755ea192b80f3a8470d5fb8827caa9bba236537
+  data.tar.gz: 4938ea8d8fe0f5cc0fac99eb4eec1a0f0ff6a73ce7ca6a388cc525327530aa1798e7fa5756d2c35687f9f441693c753c53f3c941193f8b1333226d0094c70c45

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+### v0.1.0alpha2 / 2014-07-01
+
+* 1 major change
+
+  * Deprecated internal module mixin in favor of module class extension
+
+### v0.1.0alpha01 / 2014-06-30
+
+* 2 major changes
+
+  * Module Internal mixin to add internal methods for singleton classes and objects.
+  * Created internal method for singleton classes
+  * Create internal method for class instance objects
+

data/Gemfile

@@ -4,5 +4,11 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'pry'
-gem 'pry-debugger'
+gem 'pry-doc'
+if RUBY_VERSION < '2.0.0'
+  gem 'pry-debugger'
+else
+  gem 'pry-byebug'
+end
 gem 'pry-stack_explorer'
+

data/design_rationale.md

@@ -1,9 +1,5 @@
-# First Attempt
-
-This attempt is based on the following concepts:
-
-1. Create module Internal to extend a given class 'Foo'
-2. Use protected to define the internal interface
-3. Use binding_of_caller gem to udpate the methods visibility
-
-## NOTE: Abandoned since we couldn't get a solution for class methods
+* Extend Module class with new internal method
+* Use binding_of_caller to infer if it is internal or not
+* Create aditional methods:
+  * internal_instance_methods
+  * internal_methods

data/lib/internal.rb

@@ -1,86 +1,5 @@
 require 'internal/version'
-require 'binding_of_caller'
+require 'module'
 
 module Internal
-  def caller_internal?
-    caller_namespace_root == class_namespace_root
-  end
-  private :caller_internal?
-
-  def caller_namespace_root
-    namespace_root binding.of_caller(3).eval('self.class.name')
-  end
-  private :caller_namespace_root
-
-  def class_namespace_root
-    namespace_root self.name
-  end
-  private :class_namespace_root
-
-  def internal_methods
-    @internal_methods ||= protected_methods
-  end
-  private :internal_methods
-
-  def internal_instance_methods
-    @internal_instance_methods ||= protected_instance_methods
-  end
-  private :internal_instance_methods
-
-  def namespace_root(namespace)
-    namespace.sub!(/\A([A-Z][a-z_]*)((::.*))*\z/, '\\1')
-  end
-  private :namespace_root
-
-  def new *args
-    caller_internal? ? set_internal_instance_methods_public! : set_internal_instance_methods_protected!
-    super *args
-  end
-  public :new
-
-  def set_internal_class_methods_protected!
-    internal_methods.each { |m| self.instance_eval("class << self; protected :#{m}; end") }
-  end
-  private :set_internal_class_methods_protected!
-
-  def set_internal_class_methods_public!
-    internal_methods.each { |m| self.instance_eval("class << self; public :#{m}; end") }
-  end
-  private :set_internal_class_methods_public!
-
-  def set_internal_instance_methods_protected!
-    internal_instance_methods.each { |m| protected m }
-  end
-  private :set_internal_instance_methods_protected!
-
-  def set_internal_instance_methods_public!
-    internal_instance_methods.each { |m| public m } 
-  end
-  private :set_internal_instance_methods_public!
-
-  alias_method :old_public_method_defined?, :public_method_defined?
-  def public_method_defined?(*args)
-    old_public_method_defined?(*args)
-  end
-  public :public_method_defined?
-
-  alias_method :old_public_methods, :public_methods
-  def public_methods
-    ret = old_public_methods
-    ret << internal_methods if caller_internal?
-  end
-  public :public_methods
-
-  alias_method :old_protected_methods, :protected_methods
-  def protected_methods
-    caller_internal? ? [] : internal_methods
-  end
-  protected :protected_methods
-
-  def work_internal_class_methods!
-    internal_methods.each do |m|
-      self.instance_eval("alias_method old_#{m} #{m}; def #{m}(*args); raise NoMethodError if !caller_internal?; old_#{m}(*args); end")
-    end
-  end
-  private :work_internal_class_methods!
 end

data/lib/internal/version.rb

@@ -1,37 +1,33 @@
 module Internal
   def self.version
-    critical = 0 # Broken backwards compatibility of public interface
-                 # Production code based on previous releases maybe be broken by this release
-    major = 1 # Changed public interface. No backwards compatibility issues.
+    # Any third party software should rely only on current major version
+    # Any release under the current major release should be good.
+    # Use: gem 'internal', '~> 1.0'
+    #
+    # Any extension to the current gem should rely only on current major and minor release.
+    # A Change to the major or minor release can brake the extension
+    # Usage: gem 'internal', '~> 1.1.0'
+    major = 0 # Broken backwards compatibility of public interface
+              # Production code based on previous releases maybe be broken by this release
+    minor = 1 # Changed public interface. No backwards compatibility issues.
               # Production code based on previous releases should not present any issues after upgrade.
               # Production code based on this release may be broken when using previous releases.
-    minor = 0 # Changed internal interface
+              # Changes to internal interface with broken backwards compatibility
+              # Library extensions may be broken 
+    tiny = 0 # Changed internal interface with backward compatibility
               # There should be no impact on third party software
-              # Library extensions using library internal interface may be broken. 
-    patch = nil # Changed private interface (protected and/or private methods). Bug fixes. Refactoring. 
-                # Patch needs to increase for each commit. Patch is a three digits figure.
-                # No side effects of any sort should be detected
-    alpha = 1 # First phase of development of new major or critical release
-    beta = nil # release candidate for first critical release (v0.9.0, v1.0.0.0beta1, v1.0.0)
-    pre_release = nil # release candidate of new minor releases
-    release_candidate = nil # Used before releasing new major or critical releases
+              # Library extensions using library internal interface are not broken. 
+              # Changed private interface (protected and/or private methods). Bug fixes. Refactoring. 
+              # No side effects of any sort should be detected
+    alpha = 2 # First phase of development of new major, minor or patch release
+    release_candidate = nil # Used before releasing new minor or major releases
 
-    version = "#{critical}.#{major}.#{minor}"
-
-    if patch
-      version += ".#{'%03d' % patch}"
-    elsif pre_release
-      version += "pre#{'%02d' % pre_release}"
+    "#{major}.#{minor}.#{tiny}" << if alpha
+      ".alpha#{alpha}"
     elsif release_candidate
-      version += "rc#{release_candidate}"
-    elsif alpha
-      version += "alpha#{'%02d' % alpha}"
-    elsif beta
-      version += "beta#{beta}"
+      ".rc#{release_candidate}"
     end
-    version
   end
 
-
-  VERSION = version
+  VERSION = version.freeze
 end

data/lib/module.rb

@@ -0,0 +1,43 @@
+class Module
+  def internal_instance_methods
+    @@internal_instance_methods ||= []
+  end
+
+  def internal_methods
+    @@internal_methods ||= []
+  end
+
+  def internal(meth)
+    if caller[0] =~ /\A.*`singletonclass'\z/
+      caller_stack = 1
+      eval_string = 'self.name'
+      internal_instance_methods << meth
+    else
+      caller_stack = 1
+      eval_string = 'self.class.name'
+      internal_methods << meth
+    end
+
+    # alias to create instance method alias
+    #self.instance_eval("alias_method :__rbint_#{meth}, :#{meth}")
+    # same thing as
+    alias_method :"__rbint_#{meth}", meth
+
+    # create class method
+    self.class_eval( "def #{meth}
+      require 'binding_of_caller'
+      cn = binding.of_caller(#{caller_stack}).eval('#{eval_string}')
+      a = self.class.namespace_root(cn)
+      b = self.class.namespace_root(#{eval_string})
+      if a != b
+        raise NoMethodError 
+      end
+      send('__rbint_#{meth}')
+    end")
+  end
+
+  def namespace_root(namespace)
+    namespace.sub!(/\A(([A-Z]{1}[a-z_]*)+)((::.*))*\z/, '\\1')
+  end
+  public :namespace_root
+end

data/test/module_test.rb

@@ -0,0 +1,52 @@
+$:.unshift(File.expand_path('../../lib', __FILE__))
+
+require 'module'
+require 'minitest'
+require 'minitest/autorun'
+require 'pry'
+
+module Foo
+  class Foo::Bar
+    def bar
+      'bar'
+    end
+    internal :bar
+
+    class << self
+      def baz
+        'baz'
+      end
+      internal :baz
+    end
+  end
+end
+
+class Foo::Baz
+  def self.baz
+    Foo::Bar.baz
+  end
+
+  def bar
+    Foo::Bar.new.bar
+  end
+end
+
+class InternalTest < Minitest::Test
+  def test_internal_instance_method_call
+    assert_equal 'bar', ::Foo::Baz.new.bar
+  end
+
+  def test_internal_class_method_call
+    assert_equal 'baz', ::Foo::Baz.baz
+  end
+
+  def test_external_instance_method_call
+    assert_raises(NoMethodError) { Foo::Bar.new.bar }
+  end
+
+  def test_external_class_method_call
+    assert_raises(NoMethodError) { Foo::Bar.baz }
+  end
+end
+
+

metadata

@@ -1,141 +1,110 @@
 --- !ruby/object:Gem::Specification
 name: internal
 version: !ruby/object:Gem::Version
-  version: 0.1.0alpha01
-  prerelease: 5
+  version: 0.1.0.alpha2
 platform: ruby
 authors:
 - Daniel da Silva Ferreira (dsferreira)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-30 00:00:00.000000000 Z
+date: 2014-07-13 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: sender
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: binding_of_caller
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.3'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
 description: Internal
 email:
-- danieldasilvaferreira@gmail.com
+- daniel.ferreira@dsferreira.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rvmrc
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
 - design_rationale.md
-- internal.gemspec
 - lib/internal.rb
 - lib/internal/version.rb
-- test/internal_test.rb
-homepage: ''
+- lib/module.rb
+- test/module_test.rb
+homepage: http://github.com/dsferreira/internal
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 4162978592114588374
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>'
+  - - ">"
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Makes a class, module or method internal
 test_files:
-- test/internal_test.rb
+- test/module_test.rb

data/.gitignore

@@ -1,17 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp

data/.rvmrc

@@ -1 +0,0 @@
-rvm --create use "ruby-1.9.3-p392@internal"

data/Rakefile

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

data/internal.gemspec

@@ -1,26 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'internal/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'internal'
-  spec.version       = Internal::VERSION
-  spec.authors       = ['Daniel da Silva Ferreira (dsferreira)']
-  spec.email         = ['danieldasilvaferreira@gmail.com']
-  spec.description   = %q{Internal}
-  spec.summary       = %q{Makes a class, module or method internal}
-  spec.homepage      = ''
-  spec.license       = 'MIT'
-
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ['lib']
-
-  spec.add_dependency 'sender'
-  spec.add_dependency 'binding_of_caller'
-  spec.add_development_dependency 'bundler', '~> 1.3'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'minitest'
-end

data/test/internal_test.rb

@@ -1,67 +0,0 @@
-$:.unshift(File.expand_path('../../lib', __FILE__))
-
-require 'pry'
-require 'minitest'
-require 'minitest/autorun'
-require 'internal'
-
-module Foo
-end
-
-class Foo::Bar
-  extend Internal
-
-  def initialize(*args)
-    @args = args
-  end
-  
-  def bar
-    @args
-  end
-  protected :bar
-
-  class << self
-    def baz
-      'baz'
-    end
-    public :baz
-  end
-end
-
-class Foo::Baz
-  def self.baz
-    Foo::Bar.baz
-  end
-
-  def bar(*args)
-    Foo::Bar.new(*args).bar
-  end
-end
-
-class Bar
-  def self.baz
-    Foo::Bar.baz
-  end
-
-  def bar(*args)
-    Foo::Bar.new(*args).bar
-  end
-end
-
-class InternalTest < Minitest::Test
-  def test_internal_class_instance_method
-    assert_equal ::Foo::Baz.new.bar('a'), ['a']
-  end
-
-  def test_internal_class_singleton_method
-    assert_equal ::Foo::Baz.baz, 'baz'
-  end
-
-  def test_external_class_instance_method
-    assert_raises(NoMethodError) { ::Bar.new.bar('a') }
-  end
-
-  def test_external_class_singleton_method
-    assert_raises(NoMethodError) { ::Bar.baz }
-  end
-end