defined_methods 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 92081241f72f2a2fc81b90f2af86a0c3ce3856e9
+  data.tar.gz: 52f026a0b2121185de3a1150308cba584f7badca
+SHA512:
+  metadata.gz: 839d8535bd50df2b2a648da82b51d8b179f31258b8801297364d9e31ff91ea520f2e26e302d821adecd462fc5371834aee0fdc156bf566f4311a8901ffcf2557
+  data.tar.gz: 435c312ffb10792c546a5ab8b36b539e980d736cc023782c3f53dc84713248baa352260b59c436939c2edc595654098b91004151d265ba218f907e567d0bfb42

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.ruby-version

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at wilfrido.nuqui@promisepay.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in defined_methods.gemspec
+gemspec
+
+gem 'activesupport'
+
+group :test, :development do
+  gem 'byebug'
+  gem 'codeclimate-test-reporter', '~> 1.0.0'
+  gem 'pry'
+  gem 'rubocop', require: false
+  gem 'simplecov', require: false
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Wilfrido T. Nuqui Jr.
+
+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,105 @@
+# DefinedMethods
+
+`DefinedMethods` is a utility module that returns methods defined in a given object. These methods are not from included or extended modules. These methods are not also from parent objects. By object, it means either a `class` or `module`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'defined_methods'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install defined_methods
+
+## Usage
+
+Given a class:
+```ruby
+class Arithmeter
+  def self.sum(a, b)
+    arithmeter = new
+    arithmeter.add a, b
+  end
+
+  def add(a, b)
+    do_add a, b
+  end
+
+  private
+
+  def do_add(a, b)
+    perform_addition a, b
+  end
+
+  protected
+
+  def perform_addition(a, b)
+    a + b
+  end
+end
+```
+
+When calling `DefinedMethods.in(Arithmeter)`, it will return
+```ruby
+[{:object_name=>"Arithmeter",
+  :object=>#<Class:Arithmeter>,
+  :methods=>[:sum],
+  :private=>false,
+  :protected=>false,
+  :singleton=>true},
+ {:object_name=>"Arithmeter",
+  :object=>#<Class:Arithmeter>,
+  :methods=>[],
+  :private=>true,
+  :protected=>false,
+  :singleton=>true},
+ {:object_name=>"Arithmeter",
+  :object=>#<Class:Arithmeter>,
+  :methods=>[],
+  :private=>false,
+  :protected=>true,
+  :singleton=>true},
+ {:object_name=>"Arithmeter",
+  :object=>Arithmeter,
+  :methods=>[:add],
+  :private=>false,
+  :protected=>false,
+  :singleton=>false},
+ {:object_name=>"Arithmeter",
+  :object=>Arithmeter,
+  :methods=>[:do_add],
+  :private=>true,
+  :protected=>false,
+  :singleton=>false},
+ {:object_name=>"Arithmeter",
+  :object=>Arithmeter,
+  :methods=>[:perform_addition],
+  :private=>false,
+  :protected=>true,
+  :singleton=>false}]
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/wnuqui/defined_methods. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the DefinedMethods project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/defined_methods/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'defined_methods'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/defined_methods.rb

@@ -0,0 +1,23 @@
+require 'defined_methods/version'
+require 'defined_methods/singleton'
+require 'defined_methods/instance'
+
+module DefinedMethods
+  class << self
+    def in(object)
+      [
+        Singleton.methods_defined_in(object),
+        Singleton.private_methods_defined_in(object),
+        Singleton.protected_methods_defined_in(object),
+        Instance.methods_defined_in(object),
+        Instance.private_methods_defined_in(object),
+        Instance.protected_methods_defined_in(object)
+      ]
+    end
+
+    def fqmn(group, method)
+      separator = group[:singleton] ? '.' : '#'
+      group[:object_name] + separator + method.to_s
+    end
+  end
+end

data/lib/defined_methods/instance.rb

@@ -0,0 +1,38 @@
+module DefinedMethods
+  module Instance
+    class << self
+      def methods_defined_in(object)
+        {
+          object_name: object.to_s,
+               object: object,
+              methods: object.instance_methods(false) - object.protected_instance_methods(false),
+              private: false,
+            protected: false,
+            singleton: false
+        }
+      end
+
+      def private_methods_defined_in(object)
+        {
+          object_name: object.to_s,
+               object: object,
+              methods: object.private_instance_methods(false),
+              private: true,
+            protected: false,
+            singleton: false
+        }
+      end
+
+      def protected_methods_defined_in(object)
+        {
+          object_name: object.to_s,
+               object: object,
+              methods: object.protected_instance_methods(false),
+              private: false,
+            protected: true,
+            singleton: false
+        }
+      end
+    end
+  end
+end

data/lib/defined_methods/singleton.rb

@@ -0,0 +1,93 @@
+module DefinedMethods
+  module Singleton
+    NOT_INCLUDED_PRIVATE_METHODS = %i[
+      inherited
+      initialize
+      attr_reader
+      attr
+      attr_accessor
+      attr_writer
+      remove_const
+      extend_object
+      append_features
+      prepend_features
+      undef_method
+      method_added
+      method_removed
+      remove_method
+      method_undefined
+      alias_method
+      public
+      private
+      initialize_copy
+      initialize_clone
+      protected
+      included
+      extended
+      prepended
+      define_method
+      refine
+      using
+      module_function
+    ]
+
+    class << self
+      def methods_defined_in(object)
+        {
+          object_name: object.to_s,
+               object: object.singleton_class,
+              methods: object.methods(false) - object.protected_methods(false),
+              private: false,
+            protected: false,
+            singleton: true
+        }
+      end
+
+      def private_methods_defined_in(object)
+        {
+          object_name: object.to_s,
+               object: object.singleton_class,
+              methods: object.private_methods(false) - NOT_INCLUDED_PRIVATE_METHODS - methods_from_extended_modules(object) - methods_from_ancestors(object),
+              private: true,
+            protected: false,
+            singleton: true
+        }
+      end
+
+      def protected_methods_defined_in(object)
+        {
+          object_name: object.to_s,
+               object: object.singleton_class,
+              methods: object.protected_methods(false) - methods_from_extended_modules(object) - methods_from_ancestors(object),
+              private: false,
+            protected: true,
+            singleton: true
+        }
+      end
+
+      private
+
+      def methods_from_extended_modules(object)
+        extended_modules = object.singleton_class.included_modules - [Kernel]
+        methods = []
+
+        extended_modules.each do |mod|
+          methods = methods + mod.instance_methods(false) + mod.private_instance_methods(false)
+        end
+
+        methods.flatten.uniq
+      end
+
+      def methods_from_ancestors(object)
+        ancestors = object.ancestors - [object, Object, Kernel, BasicObject]
+        methods = []
+
+        ancestors.each do |mod|
+          methods = methods + mod.protected_methods(false) + mod.private_methods(false)
+        end
+
+        methods.flatten.uniq
+      end
+    end
+  end
+end

data/lib/defined_methods/version.rb

@@ -0,0 +1,3 @@
+module DefinedMethods
+  VERSION = '0.1.0'
+end

data/object_methods.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'defined_methods/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'defined_methods'
+  spec.version       = DefinedMethods::VERSION
+  spec.authors       = ['Wilfrido T. Nuqui Jr.']
+  spec.email         = ['nuqui.dev@gmail.com']
+
+  spec.summary       = 'A util library that returns the methods defined in an object.'
+  spec.description   = 'A util library that returns the methods defined in an object.'
+  spec.homepage      = 'https://github.com/wnuqui/defined_methods'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: defined_methods
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Wilfrido T. Nuqui Jr.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: A util library that returns the methods defined in an object.
+email:
+- nuqui.dev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/defined_methods.rb
+- lib/defined_methods/instance.rb
+- lib/defined_methods/singleton.rb
+- lib/defined_methods/version.rb
+- object_methods.gemspec
+homepage: https://github.com/wnuqui/defined_methods
+licenses:
+- MIT
+metadata: {}
+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.6.13
+signing_key: 
+specification_version: 4
+summary: A util library that returns the methods defined in an object.
+test_files: []