phony_attribute 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c342c3be646bd5d5eed95589bd6b99148e16619a
+  data.tar.gz: e66bfe89dd7cc9a29c7332439671b954ec8789c7
+SHA512:
+  metadata.gz: caefcb8d968d74992e4e212cb1789fea73634fd07e73decbe8d1226c4d6ed62fba5a04ef983ea46a613fa14c740e524415a8b8b0a1b371eee893dbe357858fbf
+  data.tar.gz: 912b70f184a48a9964507c5ce559737639f7f98367beaeb7007716c4be77cb77daee2201237a0f408e9a50db4611eb23b6d674840650f25d3707bae2b516b007

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+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,49 @@
+# PhonyAttribute [![Build Status](https://travis-ci.org/chingor13/phony_attribute.png)](https://travis-ci.org/chingor13/phony_attribute)
+
+ActiveModel attribute serialization using [phony][phony]. Also wraps the [phony][phony] with a model.
+
+## Usage
+
+Assuming you have a column named `phone_number` on the `addresses` table, you can easily add phone number handling with:
+
+```
+class Address < ActiveRecord::Base
+  phone_attribute :phone_number
+end
+
+address = Address.new({
+  phone_number: "2065551234"
+})
+address.phone_number.format(:us_standard)
+=> (206) 555-1234
+```
+
+## Validating
+
+`PhonyAttribute` provides validation to `ActiveModel` using the `Phony.plausible?` helper.  To use:
+
+```
+class Address < ActiveRecord::Base
+  phone_attribute :phone_number
+  validates :phone_number, phony_plausible: {
+    allow_blocked: false, 
+    minimum_length: 9,
+    message: "is invalid"
+  }
+end
+```
+
+## Model
+
+`PhonyAttribute::PhoneNumber` can also be used as a standalone model. It wraps the nice methods `Phony` provides with a model that includes named formatting options.
+
+## Formatting
+
+`PhonyAttribute` comes built with a few named formats. You can add your own by adding to the `PhonyAttribute::PhoneNumber.named_formats` hash.  The value can be either an options hash (passed directly to Phony's format) or a callable Proc/lambda that yields the phone number object.
+
+
+## License
+
+This project rocks and uses MIT-LICENSE.
+
+[phony]: http://github.com/floere/phony

data/Rakefile

@@ -0,0 +1,38 @@
+#!/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    = 'PhonyAttribute'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/phony_attribute.rb

@@ -0,0 +1,7 @@
+module PhonyAttribute
+  autoload :Attribute, 'phony_attribute/attribute'
+  autoload :PhoneNumber, 'phony_attribute/phone_number'
+end
+
+require 'phony'
+require 'phony_attribute/railtie'

data/lib/phony_attribute/attribute.rb

@@ -0,0 +1,23 @@
+module PhonyAttribute
+  module Attribute
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def phone_attribute(*attributes)
+        options = attributes.extract_options!
+
+        attributes.each do |attribute|
+          serialize attribute, PhonyAttribute::PhoneNumber
+
+          method_body, line = <<-EOV, __LINE__ + 1
+            def #{attribute}=(original_phone_number)
+              write_attribute(:#{attribute}, PhonyAttribute::PhoneNumber(original_phone_number))
+            end
+          EOV
+          
+          class_eval method_body, __FILE__, line
+        end
+      end
+    end
+  end
+end

data/lib/phony_attribute/phone_number.rb

@@ -0,0 +1,111 @@
+module PhonyAttribute
+  class PhoneNumber
+    BLOCKED_NUMBER = "+17378742833"
+
+    class_attribute :default_country_code
+    class_attribute :named_formats
+    self.default_country_code = "1"
+    self.named_formats = {
+      db: {spaces: '', format: :+},
+      vcf: {spaces: '-'},
+      us_standard: Proc.new{|pn| pn.country_code == "1" ? "(#{pn.area_code}) #{pn.number1}-#{pn.number2}" : pn.format(:international, spaces: ' ') },
+      twilio: Proc.new{|pn| "#{pn.area_code}-#{pn.number1}-#{pn.number2}"}
+    }
+    
+    attr_accessor :number, :extension, :parts
+    def initialize(number)
+      @parts = []
+
+      # pre-processing
+      @number, @extension = number.split(/[xX]/)
+      return unless @number
+
+      @number = "+#{self.class.default_country_code}#{@number}" if self.class.default_country_code && !@number.match(Regexp.new("^\s*[\+#{self.class.default_country_code}]"))
+      begin
+        @number = Phony.normalize(@number)
+        @parts = Phony.split(@number.to_s)
+      rescue
+        @number = nil
+      end
+    end
+
+    def format(fmt = :+, options = {})
+      str = nil
+      if self.class.named_formats.has_key?(fmt)
+        format = self.class.named_formats[fmt]
+        if format.respond_to?(:call)
+          str = format.call(self)
+        else
+          options = options.reverse_merge(self.class.named_formats[fmt])
+        end
+      else
+        options = options.reverse_merge({spaces: '', format: fmt})
+      end
+      str ||= Phony.formatted(number, options) if number
+      str += "x#{extension}" if extension
+      str
+    end
+
+    def to_s
+      @to_s ||= format(:us_standard)
+    end
+
+    def blocked?
+      BLOCKED_NUMBER == format(:db)
+    end
+
+    def valid?
+      plausible? && @number.length >= 8
+    end
+
+    def plausible?
+      Phony.plausible?(@number)
+    end
+
+    def country_code
+      parts[0]
+    end
+
+    def area_code
+      ac = parts[1]
+      ac ? ac : nil # countries that don't have area codes will return false here
+    end
+
+    def number1
+      parts[2]
+    end
+
+    def number2
+      parts[3..-1].join("")
+    end
+
+    def ==(other)
+      to_s == other.to_s
+    end
+
+    class << self
+      def dump(number)
+        return nil if number.nil?
+        PhonyAttribute::PhoneNumber(number).format(:db)
+      end
+
+      def load(number)
+        new(number) unless number.nil? || number.blank?
+      end
+
+      def parse(number)
+        self.load(number)
+      end
+    end
+  end
+
+  module_function
+  def PhoneNumber(value)
+    case value
+    when PhoneNumber then value
+    when String then PhoneNumber.parse(value)
+    else
+      nil
+    end
+  end
+end

data/lib/phony_attribute/phony_plausible_validator.rb

@@ -0,0 +1,17 @@
+# global namespace so you can use the rails 3 "validate :field, phony_plausible: [options]"
+class PhonyPlausibleValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    return if value.blank?
+
+    pn = PhonyAttribute::PhoneNumber(value)
+    return if pn.nil?
+
+    if !pn.valid?
+      record.errors.add(attribute,  options[:message] || :invalid)
+    else
+      record.errors.add(attribute,  'is a blocked number') if pn.blocked? && !options[:allow_blocked]
+      record.errors.add(attribute, :too_short, :count => pn.number.length) if options[:minimum_length] && pn.number.length < options[:minimum_length]
+    end
+    
+  end
+end

data/lib/phony_attribute/railtie.rb

@@ -0,0 +1,12 @@
+module PhonyAttribute
+  class Railtie < ::Rails::Railtie
+
+    initializer "phony_attribute" do
+      require 'phony_attribute/phony_plausible_validator'
+      ActiveSupport.on_load :active_record do
+        include PhonyAttribute::Attribute
+      end
+    end
+
+  end
+end

data/lib/phony_attribute/version.rb

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

data/lib/tasks/phony_attribute_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :phony_attribute do
+#   # Task goes here
+# end

data/test/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |   |   |-- images
+  |   |   |-- javascripts
+  |   |   `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   |-- assets
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   `-- cache
+  |       `-- assets
+  `-- vendor
+      |-- assets
+      |   |-- javascripts
+      |   `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.