easy_attributes 0.1.3 → 0.2.0

data/lib/easy_attributes/version.rb

@@ -0,0 +1,3 @@
+module EasyAttributes
+  VERSION = "0.2.0"
+end

metadata

@@ -1,78 +1,101 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: easy_attributes
-version: !ruby/object:Gem::Version 
-  hash: 29
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 3
-  version: 0.1.3
+version: !ruby/object:Gem::Version
+  version: 0.2.0
 platform: ruby
-authors: 
+authors:
 - Allen Fair
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-
-date: 2010-08-06 00:00:00 -04:00
-default_executable: 
-dependencies: []
-
-description: Easy Attributes is a Ruby DSL to give more control to attributes.
-email: allen.fair@gmail.com
+date: 2016-04-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Easy Attributes is a Ruby DSL to give more control to attributes. It
+  provides a unique attribute enum setup, and conversions to bytes and float-as-integer
+  (money, frequencies, Ratings, etc.) / fixed-decimal precision as integer (See the
+  easy_money gem).
+email:
+- allen.fair@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- LICENSE
-- README.rdoc
-files: 
-- .document
-- .gitignore
-- LICENSE
-- README.rdoc
+extra_rdoc_files: []
+files:
+- ".document"
+- ".gitignore"
+- Gemfile
+- README.md
 - Rakefile
-- VERSION
+- bin/console
+- bin/setup
 - easy_attributes.gemspec
+- easy_attributes/.gitignore
+- easy_attributes/.travis.yml
 - lib/easy_attributes.rb
-- test/helper.rb
-- test/test_easy_attributes.rb
-has_rdoc: true
-homepage: http://github.com/afair/easy_attributes
+- lib/easy_attributes/version.rb
+homepage: https://github.com/afair/easy_attributes
 licenses: []
-
+metadata: {}
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
-require_paths: 
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 2.5.1
 signing_key: 
-specification_version: 3
-summary: Easy Attributes for Ruby
-test_files: 
-- test/helper.rb
-- test/test_easy_attributes.rb
+specification_version: 4
+summary: 'Easy Attributes for Ruby: Enum, Bytes, Money, float-as-integer views and
+  forms'
+test_files: []

data/LICENSE

@@ -1,20 +0,0 @@
-Copyright (c) 2009 Allen Fair
-
-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.rdoc

@@ -1,156 +0,0 @@
-= easy_attributes
-
-Easy Attributes is a Ruby DSL to give more control to attributes. Tested with ruby 1.87 & 1.9.2
-
-== Usage
-
-Easy Attributes works in any Ruby class, it does not require Active Record or other ORM. 
-
-First, install this from rubygems.org
- gem install easy_attributes
-
-Next, you need to configure your app to use it, by either:
- require 'rubygems'                 # Ruby application, no framework
- require 'easy_attributes'          #
- 
- config.gem 'easy_attributes'       # Rails 2.x, in your ./config/environment.rb
-
- gem 'easy_attributes'              # Rails 3.x, in your ./Gemfile
- 
-Configuration:
-  EasyAttributes::Config.orm = :active_model   # will generate some validations, etc.
-  EasyAttributes::Config.load(filename)        # Loads a file of column/value/names/descriptions
-  EasyAttributes::define(attribute_name, {:name=>value, ...})
-
-Declaration:
-
- class Record < ObjectRelationalMapperOfChoice
-   include EasyAttributes
-   
-   attr_values :field, :name=>'value', :name=>'value', ... :validate=>:active_record, :required=>true, :like=>'other' ...
-   attr_sequence  :field, :name, :name, ... ,:start=>1, :step=>1
-   attr_money  :amount, :units=>"dollars", :unit=>'$', :negative=>'%.2f CR'
-   attr_bytes  :bandwidth
- end
- 
-== attr_values 
-
-will define:
-  field()              # => value  ### if orm == :attr, attr_accessor will be installed for the attribute
-  field=(value)        # => value  ### for active_model classes
-  field_sym()          # => :name
-  field_sym=(symbol)   # => value
-  field_values()       # => {:name=>value, ...}
-  field_is?(:name)     # true if :name matches current value
-  field_is?(:name, :name, ...)  # true if value matches a given symbol
-  field_is?(:greater_than, :name) # true if the value is greater than the value of :name
-    The first argument can be one of: 
-    :greater_than, :gt, :greater_than_or_equal, :ge, :less_than, :lt, :less_than_or_equal, :le
-  field_is?(:between, :name1, :name2) # true if the value is between the corresponding values
-
-== attr_sequence 
-
-sets up a attr_values with the sequential numbering, by default starting at 1 incrementing by 1
-
-== attr_bytes
-
-Creates helper fields to display and accept byte quantities as KB, MB, GB, TB, etc.  Since a kilobyte (KB) is
-now defined as 1000 bytes, and a kibibyte (KiB) is the 1024 quantity, you wan to configure which you want to use
-
-  EasyAttributes::Config.kb_size = 1000   # Uses KB units as 1KB = 1000 bytes
-  EasyAttributes::Config.kb_size = 1024   # Uses KB units as 1KB = 1024 bytes
-  EasyAttributes::Config.kb_size = :new   # Uses KiB units as 1KiB = 1024 bytes (DEFAULT)
-  EasyAttributes::Config.kb_size = :both  # Combines usage of KB (1000) and KiB (1024) units (Watch out!)
-  
-attr_bytes creates the following methods for a :bandwidth attribute
-
-  bandwidth_bytes = "1 KB"                # => 1024
-  bandwidth_bytes                         # => "1 KB" using whatever unit is best
-  bandwidth_bytes(:MiB)                   # => "12345.67 MB" using the specified unit
-  bandwidth_bytes(:MiB, :precision=>0)    # => "123 MB"
-
-== attr_money
-
-is the inclusion of my easy_money gem 
-
-Mixin the EasyAttributes module into the (model) class you need, and declare the 
-attributes (columns) you wish you have the attr_money helpers
-
- class Ledger
-   include EasyAttributes
-   attr_accessor :amount, :euro     # Integer value of cents
-   attr_money :amount               # Creates amount_money() and amount_money=() methods
-   attr_money :amount, :units=>"dollars", :unit=>'$', :negative=>'%.2f CR'
-                                    # Creates amount_dollars() and amount_dollars=() methods
- end
-
- ledger = Ledger.new
- ledger.amount = 100                # 100 cents = $1.00
- ledger.amount_money                #=> "1.00"
- ledger.amount_money = "-123.45"
- ledger.amount                      #=> -12345 (cents)
- ledger.amount_money(:negative=>'%.2f CR', :zero=>'Free') # Uses these formats 
- ledger.amount_dollars              #=> "$123.45 CR"
-
- # Track the bets of the Gamesters of Triskelion on their drill thrall competitions.
- class ProviderWagers < ActiveRecord::Base
-   include EasyAttributes
-   attr_money :quatloos, :units=>'quatloos', :precision=>3, 
-     :zero=>'even', :nil=>'no bet', :negative=>'%.3f Loss', :unit=>'Q',
-     :negative_regex=>/^(-?)(.+\d)\s*Loss/i
-                                    # creates amount_quatloos(), amount_quatloos=()
- end
-
- # in your views
- <%= f.text_field :amount_quatloos %>  # -12000 => "Q12.000 Loss"
-
-Options for attr_money calls:
-* :money_method - Use this as the alternative name to the money-access methods
-* :units - Use this as an alternative suffix name to the money methods ('dollars' gives 'xx_dollars')
-* :precision - The number of digits implied after the decimal, default is 2
-* :separator - The character to use after the integer part, default is '.'
-* :delimiter - The character to use between every 3 digits of the integer part, default none
-* :positive - The sprintf format to use for positive numbers, default is based on precision
-* :negative - The sprintf format to use for negative numbers, default is same as :positive
-* :zero - The sprintf format to use for zero, default is same as :positive
-* :nil - The sprintf format to use for nil values, default none
-* :unit - Prepend this to the front of the money value, say '$', default none
-* :blank - Return this value when the money string is empty or has no digits on assignment
-* :negative_regex - A Regular Expression used to determine if a number is negative (and without a - sign), defaults to having a "CR" after the number
-
-===  Formatters
-You can also call or build your own custom conversions. Ensure that
-you can convert between the integer and money forms if you need to.
-
-The "money" type is a string, suitable for human editing, and will convert back into 
-integer type. If you override the formatting options, test that your money result 
-string will convert properly back to the original integer value.
-
-  include EasyAttributes
-  ...
-  puts EasyAttributes.money_to_integer( money_string, :option=>value, ... )
-  puts EasyAttributes.integer_to_money( cents_integer, :option=>value, ... )
-  puts EasyAttributes.integer_to_float( cents_integer, :option=>value, ... )
-  puts EasyAttributes.float_to_integer( money_float, :option=>value, ... )
-
-  EasyAttributes.integer_to_float( nil, blank:0 ) #=> 0.0  [Ruby 1.9.1 Syntax]
-  EasyAttributes.integer_to_float( 12345, :precision=>3 ) #=> 12.345
-  EasyAttributes.float_to_integer(12.345111, :precision=>3 ) #=> 12345
-
-The options to these methods are the same as the #attr_money declarations
-
-
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but
-   bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-== Copyright
-
-Copyright (c) 2010 Allen Fair. See LICENSE for details.

data/VERSION

@@ -1 +0,0 @@
-0.1.3

data/test/helper.rb

@@ -1,19 +0,0 @@
-require 'rubygems'
-require 'test/unit'
-
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-require 'easy_attributes'
-
-class Test::Unit::TestCase
-end
-require 'rubygems'
-require 'test/unit'
-
-
-class Sample
-  include EasyAttributes
-  attr_accessor :price, :balance
-  attr_money :price
-  attr_money :balance
-end

data/test/test_easy_attributes.rb

@@ -1,151 +0,0 @@
-require 'helper'
-EasyAttributes::Config.orm = :attr
-
-class TestEasyAttributes < Test::Unit::TestCase
-  include EasyAttributes
-  attr_sequence :tas, :n1, :n2
-  attr_values :tav, :k1=>1, :k2=>2, :k3=>3
-  attr_values :status, {}, :like=>'TestEasyAttributes#tav'
-  attr_bytes  :bw
-  attr_money  :amount
-  
-  def test_attr_sequence
-    self.tas_sym = :n1
-    assert_equal self.tas, 1
-    assert_equal self.tas_sym, :n1
-  end
-  
-  def test_attr_values
-    self.tav_sym = :k1
-    assert_equal tav, 1
-    self.tav_sym = :k2
-    assert_equal tav, 2
-    assert_equal tav_sym, :k2
-    assert_equal tav_is?(:k2), true
-    assert_equal tav_is?(:k1, :k3), false
-    #self.tav = :k1
-    #assert_equal tav, 1
-  end
-  
-  def test_like
-    self.status_sym = :k1
-    assert_equal self.status, 1
-  end
-
-  # Removed for now, not shipping my data file!
-  def test_load
-    #EasyAttributes::Config.load "values"
-    #assert_equal EasyAttributes::Config.attributes['status'][:ok], 8
-  end
-  
-  def test_attr_bytes
-    self.bw = 1024
-    assert_equal bw, 1024
-    assert_equal bw_bytes(:KiB, :precision=>0), "1 KiB"
-    self.bw = [1, :kb]
-  end
-  
-  def test_format_bytes
-    EasyAttributes::Config.kb_size = :both
-    assert_equal EasyAttributes.format_bytes( 900 ), "900 B"
-    assert_equal EasyAttributes.format_bytes( 1000 ), "1 KB"
-    assert_equal EasyAttributes.format_bytes( 12345 ), "12 KiB"
-    assert_equal EasyAttributes.format_bytes( 123456789 ), "117 MiB"
-    assert_equal EasyAttributes.format_bytes( 9999999999 ), "9.31 GiB"
-    assert_equal EasyAttributes.format_bytes( 123456789,  :KiB ), "120563.271 KiB"
-    assert_equal EasyAttributes.format_bytes( 123456789,  :KiB, 1 ), "120563.3 KiB"
-    assert_equal EasyAttributes.format_bytes( 123456789,  :KiB, 0 ), "120563 KiB"
-  end
-  
-  def test_parse_bytes
-    EasyAttributes::Config.kb_size=:both
-    assert_equal EasyAttributes.parse_bytes( "1.5 KiB" ), 1536
-    assert_equal EasyAttributes.parse_bytes( "1 gb" ), EasyAttributes::GB
-    assert_equal EasyAttributes.parse_bytes( "1kb", :kb_size=>1000 ), 1000
-    assert_equal EasyAttributes.parse_bytes( "1kb", :kb_size=>1024 ), 1024
-  end
-  
-  def test_include
-    sample = Sample.new
-    flunk "no price_money method" unless sample.respond_to?(:price_money)
-    flunk "no price_money= method" unless sample.respond_to?(:price_money=)
-  end
-
-  def test_method_money
-    s = Sample.new
-    [ 10000, 123456, 0, -1 -9876 ].each do |p|
-      s.price = p
-      m = s.price_money
-      s.price_money = m
-      flunk "Assignment error: p=#{p} m=#{m} price=#{s.price}" unless s.price = p
-    end
-  end
-
-  def test_method_money=
-    s = Sample.new
-    { "0.00"=>0, "12.34"=>1234, "-1.2345"=>-123, "12"=>1200, "4.56CR"=>-456 }.each do |m,p|
-      s.price_money = m
-      flunk "Assignment error: p=#{p} m=#{m} price=#{s.price}" unless s.price = p
-    end
-  end
-
-  def test_integer_to_money
-    assert EasyAttributes.integer_to_money(123) == '1.23'
-    assert EasyAttributes.integer_to_money(-12333) == '-123.33'
-    assert EasyAttributes.integer_to_money(0) == '0.00'
-    assert EasyAttributes.integer_to_money(nil, :nil=>'?') == '?'
-    assert EasyAttributes.integer_to_money(-1, :negative=>'%.2f CR') == '0.01 CR'
-    assert EasyAttributes.integer_to_money(0, :zero=>'free') == 'free'
-    assert EasyAttributes.integer_to_money(100, :unit=>'$') == '$1.00'
-    assert EasyAttributes.integer_to_money(100, :separator=>',') == '1,00'
-    assert EasyAttributes.integer_to_money(12345678900, :separator=>',', :delimiter=>'.') == '123.456.789,00'
-    assert EasyAttributes.integer_to_money(333, :precision=>3) == '0.333'
-    assert EasyAttributes.integer_to_money(111, :precision=>1) == '11.1'
-    assert EasyAttributes.integer_to_money(111, :precision=>0) == '111'
-  end
-
-  def test_money_to_integer
-    assert EasyAttributes.money_to_integer('1.23'        ) == 123
-    assert EasyAttributes.money_to_integer('0.00'        ) == 0
-    assert EasyAttributes.money_to_integer('-1.23'       ) == -123
-    assert EasyAttributes.money_to_integer('1.23 CR'     ) == -123
-    assert EasyAttributes.money_to_integer('$-2.34 CR'   ) == 234
-    assert EasyAttributes.money_to_integer('   1.234'    ) == 123
-    assert EasyAttributes.money_to_integer('$1'          ) == 100
-    assert EasyAttributes.money_to_integer('1'           ) == 100
-    assert EasyAttributes.money_to_integer(''            ) == nil
-    assert EasyAttributes.money_to_integer('1,00', :separator=>',',:delimiter=>'.') == 100
-    assert EasyAttributes.money_to_integer('$123.456.789,00 CR', :separator=>',',:delimiter=>'.') == -12345678900
-    assert EasyAttributes.money_to_integer('4.44', :precision=>4 ) == 44400
-    assert EasyAttributes.money_to_integer('4.44', :precision=>0 ) == 4
-  end
-
-  def test_float_to_integer
-    assert EasyAttributes.float_to_integer(1.00   ) == 100
-    assert EasyAttributes.float_to_integer(1.001  ) == 100
-    assert EasyAttributes.float_to_integer(-1.23  ) == -123
-    assert EasyAttributes.float_to_integer(9.0    ) == 900
-    assert EasyAttributes.float_to_integer(nil    ) == nil
-    assert EasyAttributes.float_to_integer(0.00   ) == 0
-  end
-
-  def test_integer_to_float
-    assert EasyAttributes.integer_to_float(1      ) == 0.01
-    assert EasyAttributes.integer_to_float(0      ) == 0.0
-    assert EasyAttributes.integer_to_float(-100   ) == -1.00
-    assert EasyAttributes.integer_to_float(nil    ) == nil
-    assert EasyAttributes.integer_to_float(9999888, :precision=>3 ) == 9999.888
-  end
-  
-  def test_format_money
-    assert EasyAttributes.format_money(12345) == '123.45'
-    assert EasyAttributes.format_money(12345, "%07.2m") == '0000123.45'
-    assert EasyAttributes.format_money(12345, "%07.3m") == '0000123.450'
-    assert EasyAttributes.format_money(12345, "%m") == '123'
-    assert EasyAttributes.format_money(12345, "free") == 'free'
-    assert EasyAttributes.format_money(-12345) == '-123.45'
-    assert EasyAttributes.format_money(-12345, "%07.1m") == '-000123.4'
-    assert EasyAttributes.format_money(-1) == '-0.01'
-  end
-  
-end