soundcord_rails 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.3

data/Gemfile

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

data/README.md

@@ -0,0 +1,87 @@
+#SoundCord Rails
+SoundCord Rails is intended as an easy phonetic engine for Active Record. The intent behind it was to keep setup, and dealing with it, as easy as possible and to treat phonetic database searchs as much like other attributes as possible. This means that the possible results for a query are maximized by the phonetic algorithm, even when the input has writing errors.
+
+The basics of soundcord_rails are quite simple: Declare that your model has a phonetic field with the `phonetized` method and give it a name.
+
+Soundcord_rails will automatically set its phonetized counterpart.
+
+##Installation
+SoundCord Rails is distributed as a gem, which is how it should be used is your app.
+
+Include the gem in you gemfile.
+
+```
+gem "soundcord_rails"
+```
+
+Or, if you want to get the latest, you can get master from the main soundcord_rails repository:
+
+```
+gem "soundcord_rails", :git => "git@github.com:lukasalexandre/soundcord_rails.git"
+```
+
+If you`are trying to use features that don't seem to be in the latest released gem, but are mentioned in the README, then you probably need to specify the master branch if you want to use them. This README is probably ahead of the  latest released version, if you're reading it on GitHub.
+
+##Quick start
+In your model:
+
+```ruby
+Class User < ActiveRecord::Base
+  phonetized :name
+end
+```
+
+In your migrations:
+
+```ruby
+class addPhonetizedColumnsToUsers < ActiveRecord::Migration
+  def self.up
+    change_table :users do |t|
+      t.string :name_phonetized
+    end
+  end
+
+  def self.down
+    remove_column :users, :name_phonetized
+  end
+end
+```
+
+Or you can use migration generator: `rails generate soundcord_rails user name`
+
+##Information
+
+###To do:
+
+* Add initializer options;
+* Search within database.
+
+##How to contribute
+Please ensure that you provide appropriate test coverage and ensure the documentation is up-to-date. It is encouraged that you perform changes in a clean topic branch rather than a master and that you create a pull request for them. This will facilitate discussion and revision.
+
+Please be clean, keep your commits atomic and with the smallest possible logical change. This will increase the likelihood of your submission to be used.
+
+###Bug reports
+
+If you discover any bugs, feel free to create an issue on GitHub. Please add as much information as possible to help us fixing the possible bug.
+
+https://github.com/lukasalexandre/soundcord_rails/issues
+
+##License
+Copyright (c) 2012 Lukas Alexandre. http://www.devinscene.com.br/
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to use, copy and modify copies of the Software, 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/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/generators/initializer_generator.rb

@@ -0,0 +1,10 @@
+require 'rails/generators/active_record'
+
+class InitializerGenerator < Rails::Generators::Base
+  source_root File.expand_path("../templates", __FILE__)
+
+  desc "This generator creates an initializer file at config/initializers"
+  def copy_initializer_file
+    copy_file "initializer.rb", "config/initializers/#{file_name}.rb"
+  end
+end

data/lib/generators/soundcord_rails/soundcord_rails_generator.rb

@@ -0,0 +1,32 @@
+require 'rails/generators/active_record'
+
+class SoundcordRailsGenerator < ActiveRecord::Generators::Base
+  desc "Create a migration to add soundcord-specific field to your model. " +
+       "The NAME argument is the name of your model, and the following " +
+       "arguments are the name of the columns to be phonetized"
+
+  argument :column_names, :required => true, :type => :array, :desc => "The names of the column(s) to phonetize.",
+           :banner => "field_one field_two field_three ..."
+
+  def self.source_root
+    @source_root ||= File.expand_path('../templates', __FILE__)
+  end
+
+  def generate_migration
+    migration_template "soundcord_rails_migration.rb.erb", "db/migrate/#{migration_file_name}"
+  end
+
+  protected
+
+  def migration_name
+    "add_phonetized_columns_#{column_names.join("_")}_to_#{name.underscore.pluralize}"
+  end
+
+  def migration_file_name
+    "#{migration_name}.rb"
+  end
+
+  def migration_class_name
+    migration_name.camelize
+  end
+end

data/lib/generators/soundcord_rails/templates/soundcord_rails_migration.rb.erb

@@ -0,0 +1,15 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+  def self.up
+    change_table :<%= table_name %> do |t|
+  <% column_names.each do |column| -%>
+    t.string :<%= column %>_phonetized
+<% end -%>
+    end
+  end
+
+  def self.down
+<% column_names.each do |column| -%>
+    remove_column :<%= table_name %>, :<%= column %>
+<% end -%>
+  end
+end

data/lib/soundcord_rails/glue.rb

@@ -0,0 +1,8 @@
+module SoundcordRails
+  module Glue
+    def self.included(base)
+      base.extend ClassMethods
+      base.class_attribute :phonetized_definitions
+    end
+  end
+end

data/lib/soundcord_rails/railtie.rb

@@ -0,0 +1,25 @@
+require 'soundcord_rails'
+require 'soundcord_rails/glue'
+
+module SoundcordRails
+  require 'rails'
+
+  class Railtie < Rails::Railtie
+    initializer 'soundcord_rails.insert_into_active_record' do |app|
+      ActiveSupport.on_load :active_record do
+        SoundcordRails::Railtie.insert
+      end
+    end
+  end
+
+  class Railtie
+    def self.insert
+      # SoundcordRails.options[:logger] = Rails.logger
+
+      if defined?(ActiveRecord)
+        # SoundcordRails.options[:logger] = ActiveRecord::Base.logger
+        ActiveRecord::Base.send(:include, SoundcordRails::Glue)
+      end
+    end
+  end
+end

data/lib/soundcord_rails/version.rb

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

data/lib/soundcord_rails.rb

@@ -0,0 +1,50 @@
+# SoundCord Rails is intended as an easy phonetic engine for Active Record.
+# The intent behind it was to keep setup, and dealing with it, as easy as
+# possible and to treat phonetic database searchs as much like other attributes
+# as possible. This means that the possible results for a query are maximized by
+# the phonetic algorithm, even when the input has writing errors.
+#
+# Author:: Lukas Alexandre
+# Copyright:: Copyright (c) 2012 thoughtbot, inc.
+# License:: MIT License (http://www.opensource.org/licenses/mit-license.php)
+
+require "soundcord_rails/version"
+require 'soundcord'
+
+require 'soundcord_rails/railtie' if defined?(Rails)
+
+# The base module that gets included in ActiveRecord::Base. See the
+# documentation for SoundcordRails::ClassMethods for more useful information.
+module SoundcordRails
+
+  module ClassMethods
+    # +phonetized+ gives the class, it is called on, an attribute that maps to the phonetized
+    # version of him self. The phonetized field will be automatically filled upon record +save+.
+    # Likewise, if the attribute is set to +nil+ is the phonetized field will *not* be deleted
+    # until +save+ is called.
+    #
+    #   class Person < ActiveRecord::Base
+    #     phonetized :name
+    #   end
+    def phonetized(name)
+
+      if phonetized_definitions.nil?
+        self.phonetized_definitions = {}
+      else
+        self.phonetized_definitions = self.phonetized_definitions.dup
+      end
+
+      define_method "update_#{name}_phonetized" do
+        send("#{name}_phonetized=", send(name).phonetize)
+      end
+
+      before_save "update_#{name}_phonetized"
+    end
+
+    # Returns the attachment definitions defined by each call to
+    # has_attached_file.
+    def phonetized_definitions
+      self.phonetized_definitions
+    end
+  end
+end

data/soundcord_rails.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "soundcord_rails/version"
+
+Gem::Specification.new do |s|
+  s.name        = "soundcord_rails"
+  s.version     = SoundcordRails::VERSION
+  s.authors     = ["Lukas Alexandre"]
+  s.email       = ["lukeskytm@gmail.com"]
+  s.homepage    = "https://github.com/lukasalexandre/soundcord_rails"
+  s.summary     = %q{Phonetic fields as attributes for ActiveRecord}
+  s.description = %q{Easy phonetic comparisons for ActiveRecord}
+
+  s.rubyforge_project = "soundcordrails"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'soundcord', '~> 0.1.1'
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: soundcord_rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Lukas Alexandre
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: soundcord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+description: Easy phonetic comparisons for ActiveRecord
+email:
+- lukeskytm@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- README.md
+- Rakefile
+- lib/generators/initializer_generator.rb
+- lib/generators/soundcord_rails/USAGE
+- lib/generators/soundcord_rails/soundcord_rails_generator.rb
+- lib/generators/soundcord_rails/templates/soundcord_rails_migration.rb.erb
+- lib/soundcord_rails.rb
+- lib/soundcord_rails/glue.rb
+- lib/soundcord_rails/railtie.rb
+- lib/soundcord_rails/version.rb
+- soundcord_rails.gemspec
+homepage: https://github.com/lukasalexandre/soundcord_rails
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: soundcordrails
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Phonetic fields as attributes for ActiveRecord
+test_files: []