try_corder 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4e0767384e9478c0898b50f395c7514e4aa6bc0d
+  data.tar.gz: b5887fa74a1880259388ae55568212b75cdf99e0
+SHA512:
+  metadata.gz: 88df6e951f7b2ab191a594a9d7ef81edeb29879e72b840c238ca373706fdc719797d916538bd3f2a9be422d56d9770bbb8a62c0c1062816c28cf6513bd0cba79
+  data.tar.gz: 39d45e91d829fba780f6a3ed39f98977cd9609b3993ace280da084f2b3d4d549673f83ad2e44a91f71cab2d7f4ce9bf1f8ffcb10a37c4ed72d16123a38c64baf

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

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

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 kerrizor@kerrizor.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,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in try_corder.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    try_corder (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (9.1.0)
+    minitest (5.10.3)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  byebug
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  try_corder!
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Kerri Miller
+
+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,97 @@
+# TryCorder
+
+Recently I had a Twitter conversation about the over-reliance on `try` in the Rails community, rather than folks using a NullObject pattern. It is a straight-forward task to search a codebase for uses of `try`, but I was more interested in which classes it was being called on. This gem creates a singleton for counting each use, and provides a method (`report`) for producing a running total.
+
+This code is very much a proof-of-concept, and should NOT be run in production. I've been using it during test runs to get a _sense_ of how a given Rails application is employing the method, and as a precursor to writing a more interesting method usage tracking tool.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :test do
+  gem 'try_corder'
+end
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install try_corder
+
+## Usage
+
+Include the reporting output in your rspec helper file like so:
+
+```ruby
+RSpec.configure do |config|
+  config.after(:suite) do
+    TryCorder::Reporter.report
+  end
+end
+```
+
+The gem will print out usage numbers at the end of your RSpec run.
+
+```
+💗  ➜  rspec ./spec/models/user_spec.rb
+Run options: include {:focus=>true}
+
+All examples were filtered out; ignoring {:focus=>true}
+
+Randomized with seed 15281
+.........................................................................................................................................................................................................................................................
+
+=====================
+
+User
+--------------------
+app/models/user.rb:338:: 129
+app/models/user.rb:759:: 421
+app/models/user.rb:184:: 6
+
+
+Total uses of :try for this class: 556
+
+Organization
+--------------------
+app/models/user.rb:338:: 129
+
+
+Total uses of :try for this class: 129
+
+RSpec::Mocks::Double
+--------------------
+app/models/user.rb:604:: 1
+
+
+Total uses of :try for this class: 1
+
+=====================
+
+Finished in 37.44 seconds (files took 11.09 seconds to load)
+249 examples, 0 failures
+
+Randomized with seed 15281
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/kerrizor/try_corder. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the TryCorder project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/kerrizor/try_corder/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

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

@@ -0,0 +1,15 @@
+require "try_corder/recorder"
+require "try_corder/reporter"
+require "try_corder/version"
+
+module ObjectExtension
+  def try(*a, &b)
+    TryCorder::Recorder.count(self.class.to_s, caller(1,1).first)
+
+    super(*a, &b)
+  end
+end
+
+class Object
+  prepend ObjectExtension
+end

data/lib/try_corder/recorder.rb

@@ -0,0 +1,27 @@
+require "singleton"
+
+module TryCorder
+  class Recorder
+    include Singleton
+
+    def self.count(klass, unparsed_source_string)
+      TryCorder::Recorder.instance.count(klass, unparsed_source_string)
+    end
+
+    def count(klass, unparsed_source_string)
+      parsed_source_string = unparsed_source_string.split("in")
+      split_source_string = parsed_source_string[0].split("/app/")[1]
+
+      unless split_source_string.nil?
+        counter[klass] = {} unless counter[klass]
+
+        local_source_file = "app/" + split_source_string
+        counter[klass][local_source_file] = counter[klass][local_source_file].to_i.succ
+      end
+    end
+
+    def counter
+      @_counter ||= {}
+    end
+  end
+end

data/lib/try_corder/reporter.rb

@@ -0,0 +1,31 @@
+module TryCorder
+  class Reporter
+    def self.report
+      output = "\n\n" + divider
+
+      TryCorder::Recorder.instance.counter.each do |k,v|
+        try_count = 0
+
+        output << "#{k}\n"
+        output << "--------------------\n"
+
+        v.each do |k,v|
+          output << "#{k}: #{v}\n"
+          try_count += v
+        end
+
+        output << "\n\nTotal uses of :try for this class: #{try_count}\n\n"
+      end
+
+      output << divider
+
+      puts output
+    end
+
+    private
+
+    def self.divider
+      "=====================\n\n"
+    end
+  end
+end

data/lib/try_corder/version.rb

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

data/try_corder.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "try_corder/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "try_corder"
+  spec.version       = TryCorder::VERSION
+  spec.authors       = ["Kerri Miller"]
+  spec.email         = ["kerrizor@kerrizor.com"]
+
+  spec.summary       = %q{Count the number and location of calls to Object#try}
+  spec.description   = %q{Count the number and location of calls to Object#try}
+  spec.homepage      = "https://github.com/kerrizor/try_corder"
+  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 "byebug"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: try_corder
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kerri Miller
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-01 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: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Count the number and location of calls to Object#try
+email:
+- kerrizor@kerrizor.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/try_corder.rb
+- lib/try_corder/recorder.rb
+- lib/try_corder/reporter.rb
+- lib/try_corder/version.rb
+- try_corder.gemspec
+homepage: https://github.com/kerrizor/try_corder
+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.10
+signing_key: 
+specification_version: 4
+summary: Count the number and location of calls to Object#try
+test_files: []