in_format 0.0.1

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright 2012 Cyrus Farajpour
+
+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,125 @@
+# InFormat
+
+Easily add custom getter and setter filters for attributes on ActiveRecord objects.  These can be useful if you wish to scrub data before it hits your datastore and/or provide uniformity when reading.
+
+## Requirements
+
+For Ruby 1.9.0 and greater. Tested with Rails 3.1+ using ActiveRecord.  It should work with any ORM that provides a hash syntax for accessing attributes in Models (please let me know if you have success/failures with other ORMs).
+
+## Installation
+
+Add the requirement to your Gemfile
+
+`gem "in_format"`
+
+That's it if using ActiveRecord.  If using a different ORM you will need to `extend InFormat` on the models, add an initializer or shoehorn it in some other way.
+
+## Usage
+
+Invoke `in_format`, `phone_format` or `ssn_format` in your Model for attributes you wish to process.
+
+### in_format
+
+The `in_format` method is the most general and accepts a getter and/or a setter.  
+
+Under the hood these create setters/getters and process the value through the supplied Proc/lambda and set/read the value using the hash syntax (`self[:attribute_name]`).
+
+There is an `use_accessor` option which will override getter/setter methods matching the attribute. This can be useful if you want to combine `in_format` with `attr_accessor` or gems like [attr_encrypted](https://github.com/shuber/attr_encrypted) (just be sure that the overridden methods exist before using `in_format`).
+
+You can access the original getter by passing `true` to the new one (assuming you supplied a getter).
+
+```ruby
+class MyModel < ActiveRecord::Base
+  in_format :name, setter: lambda {|v| v.upcase }, getter: lambda {|v| "Mrs. #{v}"}
+  
+  attr_accessor :some_attribute
+  in_format :some_attribute, use_accessor: true, setter: -> v { "#{v}s"}, getter: -> v { "3 {v}"}
+end
+```
+
+<pre>
+  m = MyModel.new(name: "shirley")
+  m.name(true) #=> "SHIRLEY"
+  m.name #=> "Mrs. SHIRLEY"
+  
+  m.some_attribute = "beer"
+  m.some_attribute(true) #=> "beers"
+  m.some_attribute #=> "3 beers"
+</pre>
+
+This example is contrived and a little dangerous, `MyModel.new(name: nil) #=> splode!`, but you can do a lot with getters/setters.
+
+### phone_format
+
+`phone_format` uses `in_format` with some pre-defined getters and setters.
+
+```ruby
+class MyModel < ActiveRecord::Base
+  phone_format :phone
+  phone_format :phone_without_getter, getter: false
+end
+```
+
+<pre>
+  m = MyModel.new(phone: "(213) 222-2222", phone_without_getter: "(213) 222-2222")
+  m.name(true) #=> "2132222222"
+  m.name #=> "222-222-2222"
+  m.phone_without_getter #=> "2132222222"
+</pre>
+
+You can supply your own getter or setter like `in_format` if the defaults don't match your needs or you can pass a getter or setter with `false` to exclude it.
+
+### ssn_format
+
+`ssn_format` works much like `phone_format`, also accepts custom getters/setters.
+
+```ruby
+class MyModel < ActiveRecord::Base
+  ssn_format :ssn
+end
+```
+
+or with `attr_encrypted`
+
+```ruby
+class MyModel < ActiveRecord::Base
+  attr_encrypted :ssn # defined before call to ssn_format
+  ssn_format :ssn, use_accessor: true
+end
+```
+
+<pre>
+  m = MyModel.new(ssn: "123 45 6789")
+  m.name(true) #=> "123456789"
+  m.name #=> "123-45-6789"
+</pre>
+
+## Reccomendations
+
+If you have getters/setters you would like to re-use across many attributes or classes I would stick em all in a (well-tested) module and keep an eye out for edge cases.  You can also use `in_format` as the base for your own custom methods like `phone_format`, etc.
+
+```ruby
+module MyFormatters
+  CAPS = -> v { |v| v ? v.to_s.capitalize : "Generic Dog Name" }
+  NO_CATS = lambda do |v|
+    if v =~ /cat/
+      v.gsub("cat", "")
+    else
+      v
+    end
+  end
+end
+
+class MyModel < ActiveRecord::Base
+  in_format :dog_name, setter: MyFormatters::NO_CATS, getter: MyFormatters::CAPS
+end
+```
+
+## Upcoming
+
+Currently this is written specifically for ActiveRecord but I hope to make it compatible with more ORMs. In the meantime you can use the alias option and it should work with any ruby class.
+
+## License
+
+* Freely distributable and licensed under the [MIT license](http://cfarajpour.mit-license.org/license.html).
+* Copyright (c) 2012 Cyrus Farajpour (smoils@gmail.com) [![endorse](http://api.coderwall.com/smoil/endorsecount.png)](http://coderwall.com/smoil)

data/Rakefile

@@ -0,0 +1,31 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'InFormat'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/lib/in_format.rb

@@ -0,0 +1,7 @@
+require "in_format/core"
+require "in_format/formatters"
+
+module InFormat
+end
+
+require "in_format/railtie" if defined?(Rails)

data/lib/in_format/core.rb

@@ -0,0 +1,42 @@
+module InFormat
+
+  def in_format(attribute, opts = {})
+
+    if opts[:setter]
+      if opts[:use_accessor]
+        original_setter = self.instance_method("#{attribute}=")
+
+        define_method("#{attribute}=") do |value|
+          original_setter.bind(self).call(opts[:setter].call(value))
+        end
+      else
+        define_method("#{attribute}=") do |value|
+          self[attribute.to_sym] = opts[:setter].call(value)
+        end
+      end
+    end
+
+    if opts[:getter]
+      if opts[:use_accessor]
+        original_getter = self.instance_method(attribute)
+
+        define_method("#{attribute}") do |raw = false|
+          if raw
+            original_getter.bind(self).call
+          else
+            opts[:getter].call(original_getter.bind(self).call)
+          end
+        end
+      else
+        define_method("#{attribute}") do |raw = false|
+          if raw
+            self[attribute.to_sym]
+          else
+            opts[:getter].call(self[attribute.to_sym])
+          end
+        end
+      end
+    end
+  end
+
+end

data/lib/in_format/formatters.rb

@@ -0,0 +1,2 @@
+require "in_format/formatters/phone"
+require "in_format/formatters/ssn"

data/lib/in_format/formatters/phone.rb

@@ -0,0 +1,65 @@
+module InFormat
+
+  def phone_format(attribute, opts = {})
+    opts[:setter] = Formatters::Phone::DEFAULT_SETTER unless opts.keys.include? :setter
+    opts[:getter] = Formatters::Phone::DEFAULT_GETTER unless opts.keys.include? :getter
+
+    in_format(attribute, opts)
+  end
+
+  module Formatters
+    module Phone
+
+      DEFAULT_SETTER = lambda { |value| value.to_s.gsub(/[^\d|x]/, "") }
+
+      DEFAULT_GETTER = lambda do |value|
+        if value =~ /^\d{10,13}(x\d+)?$/
+          num, ext = value.split("x")
+          opts = { extension: ext }
+          opts.merge!(country_code: num[0..-11]) if num.length > 10
+          fmt = number_to_phone(num[(-1 * [num.length, 10].min)..-1].to_i, opts).to_s
+          fmt.gsub(" x "," x").gsub("+","")
+        else
+          value
+        end
+      end
+
+      private
+
+      # this is a slightly modified version taken from Rails ActionView::Helpers::NumberHelper
+      # credit belongs to the many people who have worked on that project
+      # code is released under the MIT License, matching the license used for this project
+      def self.number_to_phone(number, options = {})
+        return unless number
+
+        begin
+          Float(number)
+        rescue ArgumentError, TypeError
+          raise InvalidNumberError, number
+        end if options[:raise]
+
+        number       = number.to_s.strip
+        options      = options.symbolize_keys
+        area_code    = options[:area_code]
+        delimiter    = options[:delimiter] || "-"
+        extension    = options[:extension]
+        country_code = options[:country_code]
+
+        if area_code
+          number.gsub!(/(\d{1,3})(\d{3})(\d{4}$)/,"(\\1) \\2#{delimiter}\\3")
+        else
+          number.gsub!(/(\d{0,3})(\d{3})(\d{4})$/,"\\1#{delimiter}\\2#{delimiter}\\3")
+          number.slice!(0, 1) if number.starts_with?(delimiter) && !delimiter.blank?
+        end
+
+        str = []
+        str << "+#{country_code}#{delimiter}" unless country_code.blank?
+        str << number
+        str << " x #{extension}" unless extension.blank?
+        str.join
+      end
+
+    end
+  end
+
+end

data/lib/in_format/formatters/ssn.rb

@@ -0,0 +1,26 @@
+module InFormat
+
+  def ssn_format(attribute, opts = {})
+    opts[:setter] = Formatters::Ssn::DEFAULT_SETTER unless opts.keys.include? :setter
+    opts[:getter] = Formatters::Ssn::DEFAULT_GETTER unless opts.keys.include? :getter
+
+    in_format(attribute, opts)
+  end
+
+  module Formatters
+    module Ssn
+
+      DEFAULT_SETTER = lambda { |value| value.to_s.gsub(/[^\d]/, "") }
+
+      DEFAULT_GETTER = lambda do |value|
+        if value =~ /^\d{9}\z/
+          "#{value[0..2]}-#{value[3..4]}-#{value[5..8]}"
+        else
+          value
+        end
+      end
+
+    end
+  end
+
+end

data/lib/in_format/railtie.rb

@@ -0,0 +1,13 @@
+module InFormat
+  class Railtie < Rails::Railtie
+
+    initializer "in_format.initialize" do
+
+      ActiveSupport.on_load :active_record do
+        ActiveRecord::Base.extend(InFormat)
+      end
+
+    end
+
+  end
+end

data/lib/in_format/version.rb

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

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: in_format
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Cyrus Farajpour
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-18 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &70199367255320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: *70199367255320
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &70199367254520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70199367254520
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: &70199367253680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.1
+  type: :development
+  prerelease: false
+  version_requirements: *70199367253680
+- !ruby/object:Gem::Dependency
+  name: attr_encrypted
+  requirement: &70199367252600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: *70199367252600
+- !ruby/object:Gem::Dependency
+  name: wirble
+  requirement: &70199367251740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70199367251740
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: &70199367250460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70199367250460
+description: Easily add custom getter and setter filters for attributes.
+email:
+- smoils@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/in_format/core.rb
+- lib/in_format/formatters/phone.rb
+- lib/in_format/formatters/ssn.rb
+- lib/in_format/formatters.rb
+- lib/in_format/railtie.rb
+- lib/in_format/version.rb
+- lib/in_format.rb
+- LICENSE.txt
+- Rakefile
+- README.md
+homepage: https://github.com/smoil/in_format
+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'
+      segments:
+      - 0
+      hash: -1601762158341379008
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1601762158341379008
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Easily add custom getter and setter filters for attributes.
+test_files: []