methodz 0.1.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dc8bad5a7b3c5aa07afb1c8a1d62d9ed337b54c4355bbbe779b022bcb5ca712b
+  data.tar.gz: f90d2f1d2e7c3b8454ac902670dd3fffa97327e78c75c7395e29f18c058c8de4
+SHA512:
+  metadata.gz: f362e0a297b869e82eeb735a3c51357b4d200454499836082cbb8d8bf2770c7299c162ac134865bfdcf06d6a3d50f63eec7dba0318a532bd21427be470a65384
+  data.tar.gz: 9ddbe6407f54fac84eca9f8daf91ecec392a1b562f51fbd14e8d342eb1d1328fa4a44012c63e20efa51f0937f0dca18b33b4d00494cf3a927e0c27a0f950558f

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Ryan Kulp
+
+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,46 @@
+# Methodz
+
+Simple utility to query available object methods by partial name or type.
+
+```rb
+user = User.last
+
+# returns methods for this class only (ignores Object.methods, ActiveModel::Dirty, and attribute getter/setters)
+user.methodz
+
+# returns methods with 'stripe' partial match in definition
+user.methodz('stripe')
+
+# returns private methods with 'stripe' partial match
+user.methodz(q: 'stripe', type: 'private')
+
+# returns public methods with 'password' partial match
+user.methodz(q: 'password', type: 'public')
+
+# returns protected methods with 'customer' partial match
+user.methodz(q: 'stripe', type: 'private')
+```
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add methodz
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install methodz
+
+## 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 the created tag, 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/ryanckulp/methodz.
+
+## 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,27 @@
+# frozen_string_literal: true
+require 'git'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: %i[spec]
+
+task :bump do
+  repo = Git.open('.')
+  version_file = './lib/methodz/version.rb'
+  matcher = /VERSION = '(.*)'\.freeze/
+
+  file_contents = File.read(version_file)
+
+  updated = file_contents.gsub(matcher) do |v|
+    v.gsub Regexp.last_match(1), Regexp.last_match(1).succ
+  end
+
+  File.open(version_file, 'w+') { |f| f << updated }
+
+  sh 'bundle'
+
+  repo.add(version_file)
+  repo.add('Gemfile.lock')
+end

data/lib/methodz/core.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Methodz
+  class ActiveRecord::Base
+    def methodz(opts = {})
+      list = public_methods + private_methods + protected_methods - Object.methods
+      return list if opts.empty?
+
+      # simple usage, ex: user.methodz('stripe')
+      opts = { q: opts } if opts.instance_of?(String)
+
+      # query by keyword in definition
+      list = list.filter { |m| m.to_s.include?(opts[:q] || '') }
+
+      # query specific types, ex: user.methodz('stripe', type: 'private')
+      if opts[:type] && !%w[all].include?(opts[:type])
+        list = list.filter { |m| send("#{opts[:type]}_methods").include?(m) }
+      end
+
+      # remove ActiveModel::Dirty helpers, ex: will_save_change_to_{query}
+      dirty_attrz.each { |da| list = list.filter { |m| !m.to_s.include?(da.to_s) } }
+      list = list.filter { |_| dirty_attrz.any? { |da| !da.to_s.include?(opts[:q] || '') } }
+
+      # remove getter/setter attributes (seeking user-defined methods, not activerecord given)
+      attrz.each { |a| list = list.filter { |m| !m.to_s.include?(a.to_s) } }
+
+      list
+    end
+
+    def attrz
+      return [] unless respond_to?(:attributes)
+
+      attributes.keys.map(&:to_sym)
+    end
+
+    # https://api.rubyonrails.org/classes/ActiveModel/Dirty.html
+    def dirty_attrz
+      %i[
+        restore_ will_save_change_to _change_to_be_saved _for_database
+        _before_last_save _in_database _change _was _id? _previously_was
+        _before_last_save_was _came_from_ _before_type_cast _changed?
+      ]
+    end
+  end
+end

data/lib/methodz/error.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Methodz
+  class Error < StandardError; end
+end

data/lib/methodz/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Methodz
+  VERSION = '0.1.6'.freeze
+end

data/lib/methodz.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'methodz/version'
+require 'methodz/error'
+require 'methodz/core'
+
+module Methodz
+end

data/sig/methodz.rbs

@@ -0,0 +1,4 @@
+module Methodz
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: methodz
+version: !ruby/object:Gem::Version
+  version: 0.1.6
+platform: ruby
+authors:
+- Ryan Kulp
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-12-26 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- ryanckulp@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/methodz.rb
+- lib/methodz/core.rb
+- lib/methodz/error.rb
+- lib/methodz/version.rb
+- sig/methodz.rbs
+homepage: https://github.com/ryanckulp/methodz
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ryanckulp/methodz
+  source_code_uri: https://github.com/ryanckulp/methodz
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.13
+signing_key:
+specification_version: 4
+summary: Lookup object methods by partial name match or type.
+test_files: []