attr_typed 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 63551aa968c5f70cc12e5f78968504af5fdd684d
+  data.tar.gz: a85087575bed96f0853bd590a3ef101e49dd3a9d
+SHA512:
+  metadata.gz: 6561f15f3e79fdd38f8dcadbdaf26e09fd81881f278e07578ccaeae41c2d0216fa73045879ae5e24a9ee57b23aa6d6de107026ad7f561d2d884213af3c6d1c7f
+  data.tar.gz: 85c3925fed636794081343ce086294179a72e10702129f1c3e82c09fe4a651c1888d2658d14bd68d65d622a125d557c5a794cc4865a65245bfbcaa4da2e8a77a

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ferocia
+
+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,60 @@
+# AttrTyped
+
+A way to add strong typing support to your ruby attributes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'attr_typed'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install attr_typed
+
+## Usage
+
+Include the `AttrTyped` module in your class then declare your types like this:
+
+```
+  attr_typed name: :string,
+             amount: :money,
+             created_at: :time
+
+```
+
+The currently supported types are:
+
+```
+:string, :money, :time, :big_decimal, :date, :integer, :boolean, :date_time
+```
+
+The parsing behaves in a very predictable way, the only exception is when
+parsing a string of `"y"` (i.e. yes) to a boolean it will be true.
+
+If you want to log parsing failures, use `AttrTyped.logger = MyLogger`.
+
+If you want to use `:time` parsing you need to use `ActiveSupport` and have a
+default time zone setup.
+
+## Development
+
+After checking out the repo, run `bundle` to install dependencies. Then, run `rake spec` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ferocia/attr_typed.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/attr_typed.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'attr_typed/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "attr_typed"
+  spec.version       = AttrTyped::VERSION
+  spec.authors       = ["Anthony Langhorne"]
+  spec.email         = ["anthony.langhorne@ferocia.com.au"]
+
+  spec.summary       = %q{Enforce attribute types at assignment time}
+  spec.homepage      = "https://github.com/Ferocia/attr_typed"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'monetize', '>= 1.0.0'
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/attr_typed/version.rb

@@ -0,0 +1,3 @@
+module AttrTyped
+  VERSION = "1.0.0"
+end

data/lib/attr_typed.rb

@@ -0,0 +1,113 @@
+require "monetize"
+require "money"
+require "bigdecimal"
+require "date"
+
+# Ability to mix in some strong typing support for attributes
+#
+# Usage:
+#   attr_typed my_field: money,
+#              another_field: time
+#
+# Then on assigning my_field = "1.23", my_field will be co-erced to Money.new(123) ($1.23)
+#
+# Gotchas:
+#   - Don't use instance variable assignment (Use self.my_field= as opposed to @my_field=)
+#   - Due to the way string.to_f works in ruby, self.my_field = "cats" will equal $0.00
+#
+module AttrTyped
+  ALLOWED_TYPES ||= [
+    :string, :money, :time, :big_decimal, :date, :integer, :boolean, :date_time
+  ]
+
+  def self.included(klass)
+    klass.extend(ClassMethods)
+  end
+
+  class << self
+    attr_accessor :logger
+  end
+
+  def parse_typed_value(value, type)
+    public_send("parse_#{type}", value) unless value.nil?
+  rescue ArgumentError => e
+    if AttrTyped.logger
+      AttrTyped.logger.error("Error parsing '#{value}' into a #{type}")
+    end
+    raise e
+  end
+
+  def parse_string(value)
+    return value if value.is_a?(String)
+
+    value.to_s
+  end
+
+  def parse_integer(value)
+    value.to_i
+  end
+
+  def parse_date(value)
+    return value if value.is_a?(Date)
+
+    if Time.respond_to?(:zone)
+      Time.zone.parse(value).to_date
+    else
+      Date.parse(value)
+    end
+  end
+
+  def parse_date_time(value)
+    return value if value.is_a?(DateTime)
+
+    DateTime.parse(value)
+  end
+
+  def parse_big_decimal(value)
+    return value if value.is_a?(BigDecimal)
+    return value.to_d if value.is_a?(Float)
+
+    BigDecimal.new(value)
+  end
+
+  def parse_money(value)
+    return value if value.is_a?(Money)
+
+    Monetize.from_bigdecimal(BigDecimal.new(value.to_s))
+  end
+
+  def parse_time(value)
+    return value if value.is_a?(Time)
+
+    raise "ActiveSupport with a time zone set is required" unless Time.respond_to?(:zone)
+
+    Time.zone.parse(value)
+  end
+
+  def parse_boolean(value)
+    return if value.nil? && !value.is_a?(FalseClass)
+    return value if value.is_a?(TrueClass) || value.is_a?(FalseClass)
+
+    ["true", "y"].include?(value.to_s.downcase)
+  end
+
+  # Class method attr_typed
+  module ClassMethods
+    def attr_typed(attrs)
+      attrs.each do |(attribute, type)|
+        raise ArgumentError, "Unsupported type #{type}" unless ALLOWED_TYPES.include?(type)
+
+        define_method("#{attribute}_with_typing=") do |value|
+          instance_variable_set("@#{attribute}", public_send("parse_typed_value", value, type))
+        end
+
+        class_eval do
+          attr_accessor attribute
+
+          alias_method "#{attribute}_without_typing=", "#{attribute}="
+          alias_method "#{attribute}=", "#{attribute}_with_typing="
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: attr_typed
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Anthony Langhorne
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: monetize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: rspec
+  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: 
+email:
+- anthony.langhorne@ferocia.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- attr_typed.gemspec
+- lib/attr_typed.rb
+- lib/attr_typed/version.rb
+homepage: https://github.com/Ferocia/attr_typed
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Enforce attribute types at assignment time
+test_files: []