internal 0.1.0alpha01

data/.gitignore

@@ -0,0 +1,17 @@
+*.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

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

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in internal.gemspec
+gemspec
+
+gem 'pry'
+gem 'pry-debugger'
+gem 'pry-stack_explorer'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Daniel da Silva Ferreira (dsferreira)
+
+MIT License
+
+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,29 @@
+# Internal
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'internal'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install internal
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/design_rationale.md

@@ -0,0 +1,9 @@
+# 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

data/internal.gemspec

@@ -0,0 +1,26 @@
+# 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/lib/internal/version.rb

@@ -0,0 +1,37 @@
+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.
+              # 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
+              # 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
+
+    version = "#{critical}.#{major}.#{minor}"
+
+    if patch
+      version += ".#{'%03d' % patch}"
+    elsif pre_release
+      version += "pre#{'%02d' % pre_release}"
+    elsif release_candidate
+      version += "rc#{release_candidate}"
+    elsif alpha
+      version += "alpha#{'%02d' % alpha}"
+    elsif beta
+      version += "beta#{beta}"
+    end
+    version
+  end
+
+
+  VERSION = version
+end

data/lib/internal.rb

@@ -0,0 +1,86 @@
+require 'internal/version'
+require 'binding_of_caller'
+
+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/test/internal_test.rb

@@ -0,0 +1,67 @@
+$:.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

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: internal
+version: !ruby/object:Gem::Version
+  version: 0.1.0alpha01
+  prerelease: 5
+platform: ruby
+authors:
+- Daniel da Silva Ferreira (dsferreira)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-30 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Internal
+email:
+- danieldasilvaferreira@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- design_rationale.md
+- internal.gemspec
+- lib/internal.rb
+- lib/internal/version.rb
+- test/internal_test.rb
+homepage: ''
+licenses:
+- MIT
+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
+signing_key: 
+specification_version: 3
+summary: Makes a class, module or method internal
+test_files:
+- test/internal_test.rb