debug_methods 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 369c6b62b6842020dccffe315cdf1f0a390c720df1953e0719ef55ca0315f224
+  data.tar.gz: d27ccb55b354b4879cbfe3c7453300ededc96979a9ae5247c24d449f3087a820
+SHA512:
+  metadata.gz: 2b6ca796527f832c254cacd81e25c69487eaa369a4225a366cbe01811a29ca679ee6aad4de6b96cf54f4b00622854cd6df1df522f1d199cc1ec6ad30a5d5c3c7
+  data.tar.gz: 88c8be20f2baeb98ba76ce62f533ec667b6c87a575b80a871386772cdecc166569341b242de96bb5fb3efb056e8f5d874a616519833b19b9ff066db5a4ae9df5

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.commit-msg

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in debug_methods.gemspec
+gemspec
+gem 'pry'

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    debug_methods (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  debug_methods!
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 mgregory-carecloud
+
+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,89 @@
+# DebugMethods
+
+DebugMethods is a module that lets you define environment specific methods in
+your Ruby on Rails app so you can build yourself useful inspection utilities in
+development without adding weight to your classes in production.
+
+## Installation
+
+Add this line to your Rails application's Gemfile:
+
+```ruby
+gem 'debug_methods'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Just include DebugMethods in any class and wrap your debug methods in a block
+being passed to #debug_methods.
+
+```ruby
+class Thing < ApplicationRecord
+  include DebugMethods
+
+  debug_methods do
+    # expensive method that puts out attributes in pretty format
+    def list_attrs
+      longest_key_length = attributes.keys.max { |a, b| a.to_s.length <=> b.to_s.length }.length
+      puts
+      attributes.sort.to_h.each do |k, v|
+        spaces_offset = longest_key_length - k.to_s.length
+        spaces = ' ' * spaces_offset
+        puts "#{k}#{spaces}\t#{v == nil ? 'nil' : v}"
+      end
+    end
+  end
+
+end
+
+```
+
+Then your debug_methods (like `#list_attrs` above) will only be allowed in the
+development environment.
+
+```
+$ RAILS_ENV="development" rails console
+>> person = Person.new(name: "Jake", age: "30")
+>> person.list_attrs
+
+age             30
+created_at	nil
+id        	nil
+name      	Jake
+updated_at	nil
+
+$ RAILS_ENV="test" rails console
+>> person = Person.new(name: "Jake", age: "30")
+>> person.list_attrs
+NoMethodError (undefined method `list_attrs' for #<Thing id: nil, name: "Jake",
+age: 30, created_at: nil, updated_at: nil>)
+```
+
+DebugMethods defaults to only including methods in the :development environment.
+To configure which environments debug methods should be available in, add an
+initializer. Add the file `config/initializers/debug_methods.rb` and include the
+following:
+
+```ruby
+DebugMethods.configure do |config|
+  config.environments << :test
+end
+```
+
+## 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/[USERNAME]/debug_methods.
+
+## 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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "debug_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/debug_methods.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "debug_methods/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "debug_methods"
+  spec.version       = DebugMethods::VERSION
+  spec.authors       = ["mgreg90"]
+  spec.email         = ["mgregory8219@gmail.com"]
+
+  spec.summary       = %q{Write utility methods that are written onto your classes only in controlled environments}
+  spec.description   = %q{DebugMethods is a module that lets you define environment specific methods in
+  your Ruby on Rails app so you can build yourself useful inspection utilities in
+  development without adding weight to your classes in production.}
+  spec.homepage      = "https://github.com/mgreg90/debug_methods"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/debug_methods.rb

@@ -0,0 +1,30 @@
+require "debug_methods/configuration"
+require "debug_methods/version"
+
+module DebugMethods
+
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.allowed_environment?
+    defined?(Rails) && DebugMethods.configuration.environments.any? do |env|
+      Rails.env.send(:"#{env}?")
+    end
+  end
+
+  module ClassMethods
+    def debug_methods
+      yield if DebugMethods.allowed_environment?
+    end
+  end
+
+end

data/lib/debug_methods/configuration.rb

@@ -0,0 +1,12 @@
+module DebugMethods
+  class Configuration
+    attr_accessor :environments
+
+    DEFAULT_ENVIRONMENTS = [:development]
+
+    def initialize
+      @environments = DEFAULT_ENVIRONMENTS
+    end
+
+  end
+end

data/lib/debug_methods/version.rb

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

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: debug_methods
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- mgreg90
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: |-
+  DebugMethods is a module that lets you define environment specific methods in
+    your Ruby on Rails app so you can build yourself useful inspection utilities in
+    development without adding weight to your classes in production.
+email:
+- mgregory8219@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- debug_methods.gemspec
+- lib/debug_methods.rb
+- lib/debug_methods/configuration.rb
+- lib/debug_methods/version.rb
+homepage: https://github.com/mgreg90/debug_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.7.3
+signing_key: 
+specification_version: 4
+summary: Write utility methods that are written onto your classes only in controlled
+  environments
+test_files: []