attr_required 0.0.2 → 0.0.3

data/README.rdoc

@@ -1,6 +1,13 @@
 = attr_required
 
-Provide attr_required and attr_optional
+This gem provide <code>attr_required</code> and <code>attr_optional</code> like <code>attr_accessor</code>.
+
+REQUIRED and OPTIONAL are common terminology in RFCs, and used for protocol parameters.
+This gem helps RFC library developers to define which parameters (attributes in Ruby world) are REQUIRED and which are OPTIONAL.
+It might be also helpful for other developers.
+
+I've developed this gem to use for rack-oauth2, a Rack-based OAuth 2.0 library.
+http://github.com/nov/rack-oauth2
 
 == Installation
 
@@ -8,10 +15,11 @@ Provide attr_required and attr_optional
 
 == Usage
 
-Include <code>AttrRequired</code>, and use <code>attr_required</code> like <code>attr_accessor</code>
-
 # Attributes Definitions
 
+  require 'attr_required'
+  require 'attr_optional'
+
   class A
     include AttrRequired, AttrOptional
     attr_required :required_a
@@ -27,8 +35,11 @@ Include <code>AttrRequired</code>, and use <code>attr_required</code> like <code
 
   A.required_attributes #=> [:required_a]
   B.required_attributes #=> [:required_a, :required_b]
-  A.required_attributes #=> [:optional_a]
-  B.required_attributes #=> [:optional_a, :optional_b]
+  A.optional_attributes #=> [:optional_a]
+  B.optional_attributes #=> [:optional_a, :optional_b]
+
+  A.attr_required?(:required_a) #=> true
+  B.attr_optional?(:optional_b) #=> true
 
 # Instance Methods
 
@@ -42,6 +53,7 @@ Include <code>AttrRequired</code>, and use <code>attr_required</code> like <code
 
   @a.attr_required?(:required_a) #=> true
   @a.attr_optional?(:optiona_a)  #=> true
+
   @a.attr_missing? #=> true
   @a.attr_missing  #=> [:required_a]
   @a.attr_missing! #=> raise AttrRequired::AttrMissing

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/lib/attr_optional.rb

@@ -1,11 +1,10 @@
 module AttrOptional
 
   def self.included(klass)
-    klass.send :include, Includable
-    klass.send :extend, Extendable
+    klass.send :extend, ClassMethods
   end
 
-  module Extendable
+  module ClassMethods
 
     def inherited(klass)
       super
@@ -30,16 +29,12 @@ module AttrOptional
 
   end
 
-  module Includable
-
-    def optional_attributes
-      self.class.optional_attributes
-    end
-
-    def attr_optional?(key)
-      self.class.attr_optional? key
-    end
+  def optional_attributes
+    self.class.optional_attributes
+  end
 
+  def attr_optional?(key)
+    self.class.attr_optional? key
   end
 
 end

data/lib/attr_required.rb

@@ -3,11 +3,10 @@ module AttrRequired
   class AttrMissing < StandardError; end
 
   def self.included(klass)
-    klass.send :include, Includable
-    klass.send :extend, Extendable
+    klass.send :extend, ClassMethods
   end
 
-  module Extendable
+  module ClassMethods
 
     def inherited(klass)
       super
@@ -32,37 +31,33 @@ module AttrRequired
 
   end
 
-  module Includable
-
-    def required_attributes
-      self.class.required_attributes
-    end
+  def required_attributes
+    self.class.required_attributes
+  end
 
-    def attr_required?(key)
-      self.class.attr_required? key
-    end
+  def attr_required?(key)
+    self.class.attr_required? key
+  end
 
-    def attr_missing?
-      !attr_missing.empty?
-    end
+  def attr_missing?
+    !attr_missing.empty?
+  end
 
-    def attr_missing!
-      if attr_missing?
-        raise AttrMissing.new("'#{attr_missing.join('\', \'')}' required.")
-      end
+  def attr_missing!
+    if attr_missing?
+      raise AttrMissing.new("'#{attr_missing.join('\', \'')}' required.")
     end
+  end
 
-    def attr_missing
-      required_attributes.select do |key|
-        value = send(key)
-        if value.respond_to?(:empty?)
-          value.empty?
-        else
-          value.nil?
-        end
+  def attr_missing
+    required_attributes.select do |key|
+      value = send(key)
+      if value.respond_to?(:empty?)
+        value.empty?
+      else
+        value.nil?
       end
     end
-
   end
 
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: attr_required
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - nov matake
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-04 00:00:00 +09:00
+date: 2010-12-06 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency