toast 0.8.11 → 0.8.12

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cf0454352fbfd4570f9e2cca9b22b5a5af6a6b33
+  data.tar.gz: 1d65521194dce398e9f7de27f5f1f80f4596e748
+SHA512:
+  metadata.gz: 4cd09d5aa85eb63cbe58161704b1ef5c5931f85820451e543619b81428d06be48919a190d0ad2076f0ec2ae4b84546941d5e3711459ada3d104175808ebd2a3e
+  data.tar.gz: 3e1e2ead0049b65abe1998431af105ee4e09a26f2c64dc45cb5c9850970d50d99243bc79742ed5b19510a95d9032a747e396e744a0f1077fad34219877d565a3

data/README.md

@@ -1,3 +1,5 @@
+[![Gem Version](https://badge.fury.io/rb/toast.png)](http://badge.fury.io/rb/toast)
+
 Summary
 =======
 
@@ -16,8 +18,8 @@ Its main features are:
 
 Toast works with
 
-  * Ruby on Rails >= 3.1.0 (currently tested up to 3.2.11)
-  * Ruby 1.8.7 and 1.9.3
+  * Ruby on Rails >= 3.1.0 (currently tested up to 3.2.16)
+  * Ruby 1.8.7, 1.9.3, 2.0.0
 
 See the [User Manual](https://github.com/robokopp/toast/wiki/User-Manual) for a detailed description.
 

data/lib/toast/active_record_extensions.rb

@@ -8,7 +8,6 @@ module Toast
     def acts_as_resource &block
 
       @toast_configs ||= Array.new
-
       @toast_configs << Toast::ConfigDSL::Base.new(self)
 
       Blockenspiel.invoke( block, @toast_configs.last)
@@ -30,6 +29,11 @@ module Toast
             tc.media_type == media_type || tc.in_collection.media_type == media_type
           end || @toast_configs.first
         end
+
+        def toast_resource_uri_prefix
+          @toast_resource_uri_prefix ||= self.to_s.pluralize.underscore
+        end
+
       end
 
       # add instance methods
@@ -37,7 +41,7 @@ module Toast
         # Return the path segment of the URI of this record
         def uri_path
           "/" +
-            self.class.to_s.pluralize.underscore + "/" +
+            self.class.toast_resource_uri_prefix + "/" +
             self.id.to_s
         end
 
@@ -72,9 +76,10 @@ module Toast
     def resourceful_model_options
       nil
     end
-    def resource_names
-      @@all_resourceful_resource_names
-    end
+  end
+
+  def self.resourceful_models
+    Module.constants.select{ |c| (eval c).respond_to?(:toast_config)}.sort.map{|c| c.constantize}
   end
 
 end

data/lib/toast/config_dsl.rb

@@ -9,6 +9,7 @@ module Toast
         @model = model
         @readables = []
         @writables = []
+        @field_comments = {}
         @collections = []
         @singles = []
         @deletable = false
@@ -16,6 +17,7 @@ module Toast
         @pass_params_to = []
         @in_collection = ConfigDSL::InCollection.new model, self
         @media_type = "application/json"
+        @apidoc = {}
 
         @model.attr_accessible []
       end
@@ -31,7 +33,8 @@ module Toast
       end
 
       def readables= arg
-          @readables.push *ConfigDSL.sanitize(arg,"readables")
+        @field_comments.merge! ConfigDSL.get_comments(arg, 'ro')
+        @readables.push *ConfigDSL.normalize(arg,"readables")
       end
 
       # args: Array or :all, :except => Array
@@ -42,7 +45,8 @@ module Toast
 
       def writables= arg
         @model.attr_accessible *arg
-        @writables.push *ConfigDSL.sanitize(arg,"writables")
+        @field_comments.merge! ConfigDSL.get_comments(arg, 'rw')
+        @writables.push *ConfigDSL.normalize(arg,"writables")
       end
 
       # args: Array or :all, :except => Array
@@ -68,7 +72,7 @@ module Toast
       end
 
       def pass_params_to= arg
-        @pass_params_to.push *ConfigDSL.sanitize(arg,"pass_params_to")
+        @pass_params_to.push *ConfigDSL.normalize(arg,"pass_params_to")
       end
 
       def pass_params_to *arg
@@ -77,7 +81,7 @@ module Toast
       end
 
       def collections= collections=[]
-        @collections = ConfigDSL.sanitize(collections, "collections")
+        @collections = ConfigDSL.normalize(collections, "collections")
       end
 
       def collections *arg
@@ -86,7 +90,7 @@ module Toast
       end
 
       def singles= singles=[]
-        @singles = ConfigDSL.sanitize(singles, "singles")
+        @singles = ConfigDSL.normalize(singles, "singles")
       end
 
       def singles *arg
@@ -102,8 +106,18 @@ module Toast
         end
       end
 
+      def apidoc arg=nil
+        return(@apidoc) if arg.nil?
+        raise "Toast Config Error (#{model.class}): apidoc argument must be a Hash." unless arg.is_a?(Hash)
+        @apidoc = arg
+      end
+
       # non DSL methods
       dsl_methods false
+
+      def field_comments
+        @field_comments
+      end
     end
 
     class InCollection
@@ -120,7 +134,7 @@ module Toast
 
       def readables= readables
         @writables = [] # forget inherited writables
-        @readables = ConfigDSL.sanitize(readables,"readables")
+        @readables = ConfigDSL.normalize(readables,"readables")
       end
 
       def readables *arg
@@ -158,26 +172,51 @@ module Toast
         (@readables + @writables).uniq.select{|f| assocs.include?(f)}
       end
 
-    end
-
+    end # class InCollection
 
     # Helper
 
     # checks if list is made of symbols and strings
     # converts a single value to an Array
     # converts all symbols to strings
-    def self.sanitize list, name
+    def self.normalize list, name
+      # make single element list
+      list = [list] unless list.is_a? Array
+
+      # remove all comments
+      list = list.map{|x| x.is_a?(Array) ? x.first : x}
+
+      # flatten
       list = [list].flatten
 
+      # check class and stringify
       list.map do |x|
         if (!x.is_a?(Symbol) && !x.is_a?(String))
-          raise "Toast Config Error: '#{name}' should be a list of Symbols or Strings"
+          raise "Toast Config Error: '#{name}' should be a list of Symbols"
         else
           x.to_s
         end
       end
     end
 
+    # fields (readables and writables) can have comments , if passed by Arrays of the form:
+    # [symbol, comment]
+    # returns a Hash of all commented or uncommented fields as:
+    # { FIELD_NAME => {:comment => COMMENT, :type => type } }
+    def self.get_comments arg, access
+      comments = {}
+
+      if arg.is_a? Array
+        arg.each do |f|
+          if f.is_a? Array
+            comments[ f.first.to_s ] = {:comment => f[1].to_s, :access => access, :type => f[2]}
+          else
+            comments[ f.to_s ] = {:comment => '[ no comment ]', :access => access, :type => nil}
+          end
+        end
+      end
 
+      comments
+    end
   end
 end

data/lib/toast/version.rb

@@ -1,3 +1,3 @@
 module Toast
-  VERSION = '0.8.11'
+  VERSION = '0.8.12'
 end

metadata

@@ -1,87 +1,81 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: toast
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 8
-  - 11
-  version: 0.8.11
+version: !ruby/object:Gem::Version
+  version: 0.8.12
 platform: ruby
-authors: 
-- "robokopp (Robert Anni\xC3\xA9s)"
+authors:
+- robokopp (Robert Anniés)
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-09-17 00:00:00 +02:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2014-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rails
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 3
-        - 1
-        - 0
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
         version: 3.1.0
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: blockenspiel
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: blockenspiel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 4
-        - 2
+      - !ruby/object:Gem::Version
         version: 0.4.2
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rack-accept-media-types
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 9
-        version: "0.9"
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+- !ruby/object:Gem::Dependency
+  name: rack-accept-media-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
   type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: ffaker
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: ffaker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id004
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |-
   Toast is an extension to Ruby on Rails that lets you expose any
   ActiveRecord model as a resource according to the REST paradigm via a generic controller. The default
   representation format is JSON or can be anything
 email: robokopp@fernwerk.net
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.md
-files: 
+files:
 - app/controller/toast_controller.rb
 - config/routes.rb
 - lib/toast.rb
@@ -95,35 +89,27 @@ files:
 - lib/toast/resource.rb
 - lib/toast/single.rb
 - README.md
-has_rdoc: true
 homepage: https://github.com/robokopp/toast
 licenses: []
-
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+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: 1.3.6
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Toast adds a RESTful interface to ActiveRecord models in Ruby on Rails.
 test_files: []
-