find_by_shortcut 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZDcwYWE4YjIxMjU5YThjYTEzMjQ3YjM0NDgxZTZlYWViOTU5NWZmNg==
+  data.tar.gz: !binary |-
+    MDkyM2NmMzk0YzQyNDM5NGYwYWY0YTlmNTQzZTU5NzNiZGRlYTQxNg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ZTJkODU2N2NmNDMzYzAxMjVkZDE4MjgxYTAyNjliYzE4MDEyYTJmYjY3NDVm
+    ODVkN2JjODE0ZTQwZTg1N2U5YmM2YmZjMWJkNjU5ZWVmYzdiOGEyN2ZkNTA0
+    MzU2NWNkNWQ4ODQyNjIxMDQzYmYwYjAwMWJlNTU2ZmVlYmZkODE=
+  data.tar.gz: !binary |-
+    ZjhlYWZkN2ViMzdjMDg4NzkzMTVkMDYxYzZjNWFhMDhlYmQwNzFkMmE3NTc1
+    ZTIyNzJhYjI1N2RhYTcwMGEwZWE2ZjMxYTUzMzQwNjU5NjA4MGQ5ZjQyYjJl
+    YWNlZDY0OWZkMDRhNWIyNTQxMjEwOWFiZWE2MDc2YmY5YmU5N2M=

data/.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+.*.swp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Mike Nomitch
+
+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,53 @@
+= find_by_shortcut
+
+A module for faster Active Record queries in the ruby console.
+
+Allows for quick 'find_by_' calls on classes that inherit from ActiveRecord::Base.
+
+Instead of typing "find_by_attribute()" after a Class name, you can type "fb" followed by 
+the first character(s) of the attribute you want to search by. If multiple attributes
+begin with those the characters following fb, the first will be selected. Do not add any
+spaces or underscores after "fb".
+
+An alias "f" for the "find" instance method on ActiveRecord::Base classes is created.
+
+Additionally, a kernel method "f" is added which searches through all ActiveRecord 
+objects for an attribute value.
+
+
+EXAMPLES:
+
+Setup: If User inherits from ActiveRecord::Base, and has the following attributes: "id", 
+"username", and "email", you can use find_by_shortcut as follows:
+
+User.f 1
+- is the equivalent of User.find(1)
+
+
+User.fbu "OkinawaSteel"
+- is the equivalent of User.find_by_username("OkinawaSteel")
+
+
+User.fbe "email@isp.com"
+
+User.fbem "email@isp.com"
+
+User.fbemail "email@isp.com"
+
+- are all equivalents of User.find_by_email("email@isp.com")
+
+f "email@isp.com"
+
+- will search through your Active Record classes until it finds something with 'email@isp.com' as one of its attributes (slow on large databases)
+
+== Contributing to find_by_shortcut
+ 
+* Fork the project and do whatever you want.
+* Shoot me an email at 'mikenomitch@gmail.com' if you want to discuss.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+
+== Copyright
+
+Standard MIT License. See LICENSE.txt for more info (basically, feel free to do 
+whatever you want with this).

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake/testtask'
+require 'rails'
+ 
+Rake::TestTask.new do |t|
+  t.libs << 'lib/find_by_shortcut'
+  t.test_files = FileList['test/lib/find_by_shortcut/*_test.rb']
+  t.verbose = true
+end
+ 
+task :default => :test

data/find_by_shortcut.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'find_by_shortcut/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "find_by_shortcut"
+  spec.version       = FindByShortcut::VERSION
+  spec.authors       = ["Mike Nomitch", "Erik Nomitch"]
+  spec.email         = ["mikenomitch@gmail.com"]
+  spec.description   = %Q{Shortcuts for Active Record queries in the ruby console.}
+  spec.summary       = %Q{Allows for quick 'find_by_' calls on classes that inherit from ActiveRecord::Base. Instead of typing "find_by_attribute()" after a Class name, you can type "fb" followed by 
+the first character(s) of the attribute you want to search by. If multiple attributes begin with those the characters following fb, the first will be selected. Do not add any spaces or underscores after "fb".}
+  spec.homepage      = "https://github.com/mikenomitch/find_by_shortcut"
+  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"
+  spec.add_development_dependency "rails"
+end

data/lib/find_by_shortcut.rb

@@ -0,0 +1,61 @@
+require "find_by_shortcut/version"
+
+class ActiveRecord::Base
+
+  # Open the eigenclass of ActiveRecord::Base because we need to alias a static
+  # method.
+
+  # This would allow you to call Email.f 10
+  # Which shouldn't be confused with the 'f' method below.
+  class << ActiveRecord::Base
+    alias_method :f, :find
+  end
+
+  # LOOK INTO PASSING THE ARGS TO SUPER, MAYBE REMOVE thE *???
+
+  def self.method_missing(method, *args)
+    if method.to_s.starts_with?("fb")
+      # Take all characters after "fb"
+      remainder = method.to_s[2..-1]
+      # Check if there is an attribute that starts with these chatacters
+      attribute = self.new.attributes.keys.select{|e| e.starts_with?(remainder)}.first
+      # If not, run the normal 'method missing' method
+      if attribute == nil
+        super
+      else
+        # but if so, call find by on that attribute
+        new_method = "find_by_" + attribute
+        send(new_method.to_s, args)
+      end
+      # if an unknown method doesn't start with fb, run the normal 'method missing' method
+    else
+      super
+    end
+  end
+end
+
+# Feel free to comment out the section below if you don't want eager loading on your application, as this will slow it down a little bit.
+# This section allows you to call something like "f 'example@email.com'" and it will try to find the right class to match the attribute you just called
+# On medium/large databases this will be too slow to be effective
+
+def f (value)
+  # Load each class before it is explicitly called
+  Rails.application.eager_load!
+  # Enumerate through all the classes that inherit from ActiveRecord::Base
+  ActiveRecord::Base.descendants.each do |klass|
+    # Enumberate through each attribute of each class
+    klass.new.attributes.keys.each do |attribute|
+      # Call find_by for each attribute with the value that came after 'f'
+      find_method = "find_by_" + attribute
+      if klass.columns_hash[attribute].type.to_s == value.class.to_s.downcase
+        item = klass.send(find_method, value)
+        if item != nil
+          # If something is found, return it and stop the enumeration
+          return item
+        end
+      end
+    end
+  end
+  # If nothing is found, return nil
+  return nil
+end

data/lib/find_by_shortcut/version.rb

@@ -0,0 +1,3 @@
+module FindByShortcut
+  VERSION = "0.0.1"
+end

data/test/lib/find_by_shortcut/version_test.rb

@@ -0,0 +1,9 @@
+require_relative '../../test_helper'
+ 
+describe FindByShortcut do
+ 
+  it "must be defined" do
+    FindByShortcut::VERSION.wont_be_nil
+  end
+ 
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+require File.expand_path('../../lib/find_by_shortcut.rb', __FILE__)

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: find_by_shortcut
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mike Nomitch
+- Erik Nomitch
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-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.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'
+- !ruby/object:Gem::Dependency
+  name: rails
+  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: Shortcuts for Active Record queries in the ruby console.
+email:
+- mikenomitch@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- find_by_shortcut.gemspec
+- lib/find_by_shortcut.rb
+- lib/find_by_shortcut/version.rb
+- test/lib/find_by_shortcut/version_test.rb
+- test/test_helper.rb
+homepage: https://github.com/mikenomitch/find_by_shortcut
+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.3
+signing_key: 
+specification_version: 4
+summary: Allows for quick 'find_by_' calls on classes that inherit from ActiveRecord::Base.
+  Instead of typing "find_by_attribute()" after a Class name, you can type "fb" followed
+  by  the first character(s) of the attribute you want to search by. If multiple attributes
+  begin with those the characters following fb, the first will be selected. Do not
+  add any spaces or underscores after "fb".
+test_files:
+- test/lib/find_by_shortcut/version_test.rb
+- test/test_helper.rb