latent_object_detector 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a791cf6c6b8217cc5cd4535f56b915c40d797881
+  data.tar.gz: a22158208a9b31417b0e860fd4fb655d2f2789fc
+SHA512:
+  metadata.gz: 65b53dc35b2d1ee74acf7163be98abe10296706e40d6ab8467ff8ef833e34a4ddaca432d1951400bda6c5e5672839779849ebc15a361fa5e03cc49fee2dd68dc
+  data.tar.gz: f9cb8c51759b32506b76e17daaa08211cf37107df5f186cc73a2814af1af8da4874d229ebc625b5e94b373368b2a11fa46888bd240780d30802f118bc5d82acd

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - ruby-head
+script: "bundle exec rake test"

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in latent_object_detector.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Kerri Miller
+
+MIT License
+
+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,37 @@
+# Latent Object Detector
+
+[<img src="https://secure.travis-ci.org/kerrizor/latent_object_detector.png" />](http://travis-ci.org/kerrizor/latent_object_detector)
+
+Based on an original idea from Corey, this gem looks at the methods defined on an object and looks for repeated words contained in the method names, as this can sometimes illuminate latent objects, concepts, or relationships that don't currently exist in the code (but should.)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'latent_object_detector'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install latent_object_detector
+
+## Usage
+```
+d = LatentObjectDetector.for(User)
+d.potential_objects
+=> ["password", "token", "remember"]
+d.suspicious_methods
+=> [:change_password, :generate_token, :remember_token?, :remember_me, :uses_deprecated_password?, :password_matches?, :crypt_password, :password_required?, :password_handler]
+```
+ Then go refactor those latent objects!
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = "test/*_test.rb"
+end

data/TODO.md

@@ -0,0 +1,7 @@
+TODO
+====
+
+Next steps and ideas for more exploration
+
+ + use stemming and Levenshtein distances to find non-exact matches
+ + scan comments for matching words as well

data/latent_object_detector.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'latent_object_detector'
+require 'latent_object_detector/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "latent_object_detector"
+  spec.version       = LatentObjectDetector::VERSION
+  spec.authors       = ["Corey Ehmke", "Kerri Miller"]
+  spec.email         = ["corey@idolhands.com", "kerrizor@kerrizor.com"]
+  spec.description   = %q{Flags frequently used words in method names as
+                            possible latent concepts.}
+  spec.summary       = %q{Based on an original idea from Corey, this gem looks
+                            at the methods defined on an object and looks for
+                            repeated words contained in the method names, as
+                            this can sometimes illuminate latent objects,
+                            concepts, or relationships that don't currently
+                            exist in the code (but should.)}
+  spec.homepage      = "https://github.com/kerrizor/latent_object_detector"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/latent_object_detector.rb

@@ -0,0 +1,64 @@
+require "latent_object_detector/version"
+
+module LatentObjectDetector
+  class Detector
+    attr_accessor :klass
+
+    def self.for(klass)
+      new(klass)
+    end
+
+    def initialize(klass)
+      self.klass = klass
+    end
+
+    def suspicious_methods
+      methods_owned_by_klass.select{ |m| (words_in_method(m.to_s) & potential_objects).size > 0 }
+    end
+
+    def potential_objects
+      common_words = find_common_words_in(hash_of_words_used_in_methods)
+      words_used_more_than_twice(common_words)
+    end
+
+    private
+    def words_used_more_than_twice(hash_of_words = {})
+      hash_of_words.select{ |k| k.size > 2 }
+    end
+
+    def hash_of_words_used_in_methods
+      methods_owned_by_klass.inject({}) do |hash, method|
+        hash[method] = words_in_method(method)
+        hash
+      end
+    end
+
+    def find_common_words_in(hash_of_words = hash_of_words_used_in_methods)
+      count_word_frequency(hash_of_words).select{ |k,v| v > 1 }.keys
+    end
+
+    def count_word_frequency(hash_of_words = {})
+      hash_of_words.values.flatten.inject({}) do |hash, word|
+        hash[word] ||= 0
+        hash[word] += 1
+        hash
+      end
+    end
+
+    def methods_owned_by_klass
+      all_instance_methods_of_klass.select{ |method| method_is_owned_by_klass? method }
+    end
+
+    def method_is_owned_by_klass?(method)
+      self.klass.new.method(method).owner == self.klass
+    end
+
+    def all_instance_methods_of_klass
+      self.klass.instance_methods
+    end
+
+    def words_in_method(name)
+      name.to_s.gsub(/[^a-z\_]/i,'').split('_')
+    end
+  end
+end

data/lib/latent_object_detector/version.rb

@@ -0,0 +1,3 @@
+module LatentObjectDetector
+  VERSION = "0.0.2"
+end

data/test/latent_object_detector_test.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+
+class UserExample
+  def foo;end
+  def bar;end
+  def baz;end
+  def foo_bar;end
+end
+
+class LatentObjectDetectorTest < MiniTest::Unit::TestCase
+  def setup
+    @detector = LatentObjectDetector::Detector.for(UserExample)
+  end
+
+  def test_for_returns_klass
+    assert_kind_of LatentObjectDetector::Detector, @detector
+  end
+
+  def test_potential_objects
+    assert_equal ["foo", "bar"], @detector.potential_objects
+  end
+
+  def test_suspicious_methods
+    assert_equal [:foo, :bar, :foo_bar], @detector.suspicious_methods
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require './lib/latent_object_detector'
+require 'minitest/unit'
+require 'minitest/autorun'
+require 'minitest/pride'
+

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: latent_object_detector
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Corey Ehmke
+- Kerri Miller
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+description: |-
+  Flags frequently used words in method names as
+                              possible latent concepts.
+email:
+- corey@idolhands.com
+- kerrizor@kerrizor.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- TODO.md
+- latent_object_detector.gemspec
+- lib/latent_object_detector.rb
+- lib/latent_object_detector/version.rb
+- test/latent_object_detector_test.rb
+- test/test_helper.rb
+homepage: https://github.com/kerrizor/latent_object_detector
+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.0.6
+signing_key: 
+specification_version: 4
+summary: Based on an original idea from Corey, this gem looks at the methods defined
+  on an object and looks for repeated words contained in the method names, as this
+  can sometimes illuminate latent objects, concepts, or relationships that don't currently
+  exist in the code (but should.)
+test_files:
+- test/latent_object_detector_test.rb
+- test/test_helper.rb