intrinsic 1.0.0 → 1.0.3

data/CHANGELOG.mdown

@@ -0,0 +1,70 @@
+1.0.3 / 2012-01-08
+==================
+
+  * Adding the previous commit log to changelog
+  * Refactoring into single line validators
+  * Removing type due to default type being string
+  * Writing up the README documentation
+
+
+1.0.0 / 2012-01-08
+==================
+
+  * Merge branch 'release/1.0.0' into develop
+  * Incrementing the version number.
+  * Assigning errors if validation result was false
+  * Assigning the false setter to validation_result if raised
+  * Attempt to evaluate the validator
+  * Make begin, rescue, end blocks
+  * Defining under private
+  * Adding the validate action method
+  * Adding the is_valid method which calls on all the validators
+  * If validators hash is nil, make one, then fill with proerpty/vlock
+  * Defining the base add_validators method
+  * Calling the add_validators to add to list of validators
+  * Raise if the property isnt a part of the list
+  * Calling check_for_property on property
+  * Defining the base validation_for method
+  * Redifing the included method to extend with validation
+  * Require in the validation library and build skeleton
+  * Return self for chaining
+  * Set each key value as property and value
+  * Raise if any of the keys don't belong
+  * On initialize check the properties of list and define private method
+  * If value is a proc, call the proc with self as argument
+  * If no value given, print out value
+  * Print out class name, object id, and list of properties
+  * Returning self, for chaining
+  * Setting an instance variable with the property as the name and value equal to property value
+  * Making the check_for_types and property block methods private
+  * Assigning property as key and default as value for defaults
+  * Assigning property symbol to list of properties for class
+  * Building up proc, integer, and string coercion logic
+  * Defining and requiring three coercion types
+  * Building the Coercion library
+  * Require the coercion library
+  * Convert value to type and then assign to hash
+  * Defining unless statement for value of value paramater
+  * Defining a lambda that takes a single value for property_block
+  * Creating the property_block method
+  * Defining the method name with a block of the property
+  * Method for checking the types of the arguments
+  * Merginging the properties with the class defaults
+  * Initializing the defaults and properties lists as attributes
+  * Defining the property class method
+  * Building up the intrinsicism module
+  * Building up the Extrinsicism library
+  * Adding a test object to play around with for testing
+  * Building out some sample and testable data cases
+  * Adding whitespace
+  * Modifying the to_s of the model
+  * Creating a custom initialize method for intrinsic models
+  * Modifying the module method included to concern Intrinsicism
+  * Adding a skeleton test helper library
+  * Requiring a test helper library
+  * Adding the skeleton intrinsicism test
+  * Requiring the intrinsicism library
+  * Requiring the extrinsicism library
+  * Switching to single quotes
+  * Updating the gemspec with proper details
+  * Initial commit

data/README.md

@@ -1,29 +1,126 @@
-# Intrinsic
+intrinsic
+=========
 
-TODO: Write a gem description
+The intrinsic gem is for giving your objects typed attributes, defaults, and validations.
 
-## Installation
 
-Add this line to your application's Gemfile:
+usage
+-----
 
-    gem 'intrinsic'
+Using the intrinsic library is pretty simple.
+The basic features are:
 
-And then execute:
+  - Getters & Setters for named properties (similar to attr_accessor)
+  - Default values, both in regular and Proc (ie callable lambda) form
+  - Easy API for dumping object attributes (similar to ostruct)
+  - Type and Argument errors for incorrectly supplied properties
+  - Type coercion for attributes, as well as easily defininable new types
 
-    $ bundle
 
-Or install it yourself as:
+In addition you get these cool features:
 
-    $ gem install intrinsic
+  - Validate your properties with simple boolean logic, no complex Validator classes!
+  - Get errors when your validations don't work (simple errors for now)
+  -
 
-## Usage
 
-TODO: Write usage instructions here
+installing
+----------
 
-## Contributing
+**Requirements**
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+1. Ruby MRI 1.9+
+2. RubyGems 1.6+
+
+Like any other gem, all you have to do is either use:
+
+``` bash
+$ gem install
+```
+
+Or add it to your `Gemfile`:
+
+``` ruby
+source :rubygems
+
+gem "intrinsic", "1.0.1"
+```
+
+That's all you have to do.
+
+**Testing**
+
+To make sure you did everything right do the following:
+
+``` ruby
+ruby -e "p require 'intrinsic'"
+true
+```
+
+
+issues & documentation
+----------------------
+
+* [Documentation](http://krainboltgreene.github.com/intrinsic/documentation)
+* [Issues](https://github.com/krainboltgreene/intrinsic/issues)
+
+We welcome any pull requests or commits that improve `intrinsic`.
+
+
+changelog
+---------
+
+  - 1.0.3:
+      * Adding helpful README and license, updating example script
+  - 1.0.0: Initial release
+
+
+contributing
+------------
+
+* **Fork** the repository
+* **Clone the repository** locally, or **edit via Github**
+* Create a **new branch** using the [Git Flow Standard](http://yakiloo.com/getting-started-git-flow/) conventions
+* Commit **often** and **when important**
+* **DO NOT CHANGE** ANY OF THESE (without making a new branch for *that* change):
+  * `*.gemspec`
+  * `Rakefile`
+  * `.rvmrc`
+  * `.gitignore`
+  * Any part of the git history
+* **Write tests** specifically for the changes you've made, if no test exist
+* **Push** your feature or hotfix branch to Github.
+* Make a **Pull Request**
+
+
+Credits
+-------
+
+  - []()
+  - []()
+  - []()
+
+
+License
+-------
+
+Copyright (c) 2011 Kurtis Rainbolt-Greene
+
+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/example/sample.rb

@@ -4,21 +4,13 @@ class Person
   include Intrinsic
   include Intrinsic::Intrinsicism::Validation
 
-  property :name, String
-  property :email, String
+  property :name
+  property :email
   property :age, Integer, default: 13
 
-  validation_for :name do
-    name.match /\w/
-  end
-
-  validation_for :age do
-    (13..100).include? age
-  end
-
-  validation_for :email do
-    email.count('@') == 1 and email.length < 256 and email.length > 5
-  end
+  validation_for :name  { name.match /\w/ }
+  validation_for :age   { (13..100).include? age }
+  validation_for :email { email.count('@') == 1 and (5..256).include? email.length }
 end
 
 

data/lib/intrinsic/version.rb

@@ -1,3 +1,3 @@
 module Intrinsic
-  VERSION = "1.0.0"
+  VERSION = "1.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: intrinsic
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2157841500 !ruby/object:Gem::Requirement
+  requirement: &2156056780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -21,10 +21,10 @@ dependencies:
         version: 0.9.2.2
   type: :development
   prerelease: false
-  version_requirements: *2157841500
+  version_requirements: *2156056780
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2157840980 !ruby/object:Gem::Requirement
+  requirement: &2156056260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -32,7 +32,7 @@ dependencies:
         version: 0.7.4
   type: :development
   prerelease: false
-  version_requirements: *2157840980
+  version_requirements: *2156056260
 description: Intrinsic adds properties to your objects
 email:
 - kurtisrainboltgreene@gmail.com
@@ -41,6 +41,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG.mdown
 - Gemfile
 - LICENSE
 - README.md
@@ -73,7 +74,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3284528492314320514
+      hash: 1445375515393034073
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -82,7 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3284528492314320514
+      hash: 1445375515393034073
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.10