invisible 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 71eaaea3d7717f03a1c2cc31d99041521b86e5ac65d8cdd98c2a89cdb2b7f391
+  data.tar.gz: 84aab41ab090a0cf4a0e26c9fa7372cc4e021f06eb11e508c580ef7b7ed1d525
+SHA512:
+  metadata.gz: 9c3fb7f7b396583c6c23d90902750b2caccc5956fe8a740ce90f19c1342b703d6b9419f3b5df009074a39df3195c4b347a7b70b80fcd949c0a9814ccc8a38f52
+  data.tar.gz: 3e81b037145ec1c7b2335317972b6f9f50a42ffecd7ab84591578d9c4126ee0b33c47ab1273e3180a872ed2aee92bc101c09b26449b9bac7fa0899db87b65619

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in invisible.gemspec
+gemspec
+
+platforms :ruby do
+  gem 'guard-rspec'
+  gem 'pry-byebug'
+end

data/Gemfile.lock

@@ -0,0 +1,74 @@
+PATH
+  remote: .
+  specs:
+    invisible (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (11.0.1)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    ffi (1.11.1)
+    formatador (0.2.5)
+    guard (2.15.1)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    listen (3.2.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.0.13)
+    method_source (0.9.2)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.7.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
+    rake (10.5.0)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.10.0)
+      ffi (~> 1.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    shellany (0.0.1)
+    thor (0.20.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  guard-rspec
+  invisible!
+  pry-byebug
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.2

data/Guardfile

@@ -0,0 +1,70 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w(erb haml slim))
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.call("routing/#{m[1]}_routing"),
+      rspec.spec.call("controllers/#{m[1]}_controller"),
+      rspec.spec.call("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.call("features/#{m[1]}") }
+  watch(rails.layouts)       { |m| rspec.spec.call("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Chris Salzberg
+
+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,74 @@
+# Invisible
+
+Invisible allows you to quickly define method overrides in a module without worrying about messing up their original visibility. It does this in less than ten lines of code.
+
+## Usage
+
+Suppose you are defining a module which will override a bunch of methods from some class (or module). Simply `extend Invisible` and you can ignore checking whether those methods are public, protected or private -- Invisible will take care of that for you!
+
+Suppose this is the class we are overriding:
+
+```ruby
+class Base
+  def public_method
+    'public'
+  end
+
+  protected
+
+  def protected_method
+    'protected'
+  end
+
+  private
+
+  def private_method
+    'private'
+  end
+end
+```
+
+We don't want to care about whether the methods are private or whatever. So we define our module like so:
+
+```ruby
+module Foo
+  extend Invisible
+
+  def public_method
+    super + 'foo'
+  end
+
+  def protected_method
+    super + 'foo'
+  end
+
+  def private_method
+    super + 'foo'
+  end
+end
+```
+
+Normally, without Invisible, we would have just made methods that were previously `private` become `public`. But Invisible checks the original visibility and ensures that when the module is included, methods which were originally private or protected stay that way.
+
+```ruby
+class MyClass < Base
+  include Foo
+end
+
+instance = MyClass.new
+
+instance.public_method_defined?(:public_method)       #=> true
+instance.public_method                                #=> 'publicfoo'
+
+instance.protected_method_defined?(:protected_method) #=> true
+instance.protected_method                             # raises NoMethodError
+instance.send(:protected_method)                      #=> 'protectedfoo'
+
+instance.private_method_defined?(:private_method)     #=> true
+instance.private_method                               # raises NoMethodError
+instance.send(:private_method)                        #=> 'privatefoo'
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/invisible.rb

@@ -0,0 +1,71 @@
+require "invisible/version"
+
+module Invisible
+=begin
+
+Extend any module with +Invisible+ and any methods the module overrides will
+maintain their original visibility.
+
+@example
+  class Base
+    def public_method
+      'public'
+    end
+
+    protected
+
+    def protected_method
+      'protected'
+    end
+
+    private
+
+    def private_method
+      'private'
+    end
+  end
+
+  module Foo
+    extend Invisible
+
+    def public_method
+      super + 'foo'
+    end
+
+    def protected_method
+      super + 'foo'
+    end
+
+    def private_method
+      super + 'foo'
+    end
+  end
+
+  class MyClass < Base
+    include Foo
+  end
+
+  instance = MyClass.new
+
+  instance.public_method_defined?(:public_method)       #=> true
+  instance.public_method                                #=> 'publicfoo'
+
+  instance.protected_method_defined?(:protected_method) #=> true
+  instance.protected_method                             # raises NoMethodError
+  instance.send(:protected_method)                      #=> 'protectedfoo'
+
+  instance.private_method_defined?(:private_method)     #=> true
+  instance.private_method                               # raises NoMethodError
+  instance.send(:private_method)                        #=> 'privatefoo'
+
+=end
+  def append_features(base)
+    private_methods   = instance_methods.select { |m| base.private_method_defined? m }
+    protected_methods = instance_methods.select { |m| base.protected_method_defined? m }
+
+    super
+
+    private_methods.each   { |method_name| base.class_eval { private method_name } }
+    protected_methods.each { |method_name| base.class_eval { protected method_name } }
+  end
+end

data/lib/invisible/version.rb

@@ -0,0 +1,3 @@
+module Invisible
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: invisible
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Salzberg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-10-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- chris@dejimata.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/invisible.rb
+- lib/invisible/version.rb
+homepage: https://github.com/shioyama/invisible
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/shioyama/invisible
+  source_code_uri: https://github.com/shioyama/invisible
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6.2
+signing_key: 
+specification_version: 4
+summary: Override methods while maintaining their original visibility.
+test_files: []