marley 0.3.0 → 0.4.0

data/README.rdoc

@@ -43,36 +43,11 @@ Marley activates both of them for Sequel::Model.  This will soon change to an op
 One of the things that the RestConvenience Sequel plugin does is add a #controller method to affected models.  This method instantiates and returns a ModelController object for the model in question.  At initialization, the Controller parses the request path to determine the model instances to which the request refers.  
 
 
-==Joints
+:include: rdoc/joints.rdoc
 
-"Joints" are pre-packaged resource sets that can be included in a Marley application.  A joint can be added to the current Resources by running Marley.joint('_joint_name_').  The Marley.joint method will then do the following:
-
-* Find a file named '_joint_name_' in the 'joints/' directory.
-* Require that file.
-* run its #smoke method.
-
-The Joint#smoke method looks for 3 modules inside the joint's namespace:  Resources, ClassMethods, and InstanceMethods.  
-
-* if the Resources module exists, Joint#smoke will copy all of its constants to Marley::Resources.
-* If the ClassMethods module exists, Joint#smoke will cycle through the modules within it, and extend objects in Marley::Resources with the same name.
-* If the InstanceMethods module exists, Joint#smoke will cycle through the modules within it, and call their #append_features with the corresponding objects in Marley::Resources with the same name.
-
-For now, there are 5 joints included in the Marley distribution:
-
-* Basic User
-* Basic Messaging
-* Basic Menu System
-* Tagging
-* Tagged Messaging
-
-With a bit of configuration, these comprise the example forum application, which is in turn the targt for the test suite.
-
-==Reggae
-
-The server and client use a JSON based data representation format "Reggae."  Reggae.ebnf describes the format in canonical form, and reggae.rb contains a Reggae parser and generator.  
+:include: rdoc/reggae.rdoc
 
 ==Jamaica
 
 The default Marley client is "Jamaica", which consists of JS/CSS for browsers.  It sucks right now and I'm hoping somebody takes it over as a sub-project, but it does work - at least on FF.
 
-

data/Rakefile

@@ -9,3 +9,6 @@ Rake::TestTask.new(:test) do |t|
   t.test_files=FileList['test/*_tests.rb']
 end
 
+Rake::TestTask.new(:unit) do |t|
+  t.test_files=FileList['test/*_unit.rb']
+end

data/TODO

@@ -1,17 +1,19 @@
 
 
-- improve testing coverage
-- improve documentation - esp API
-
+- complete switchover to tdoc
+- joint dependencies
+- rename client to sth like output
+  - move all output there
+- fix JS
 - ditch Sequel dependency
+  - ORM as a Joint??
+  - automate sequel plugin loading in options
 
-- automate sequel plugin loading in options
-
-- better logging
+-----------------
 
-- hints for resources/columns
 - better filtering options for posts
-
-??? expose validation reflections to views
+- better logging
+- implement instance_list
+- expose validation reflections to views
 ??? caching protocol for autocompleters/validation options
 

data/lib/joints/basic_menu_system.rb

@@ -1,34 +1,17 @@
 
-module Sequel::Plugins::RestSection
-  SECTION_PROPS='name','title','description','navigation'
-  module ClassMethods
-    SECTION_PROPS.each {|p| attr_accessor :"section_#{p}"}
-    def section
-      if SECTION_PROPS.find {|p| send(:"section_#{p}").to_s > ''}
-        Marley::ReggaeSection.new(SECTION_PROPS.inject({}) do |props,p| 
-          prop=send(:"section_#{p}")
-          props[p.to_sym]=prop.class==Hash ? prop[$request[:user].class] : prop
-          props 
-        end)
-      end
-    end
-  end
-end
 module Marley
   module Joints
     class BasicMenuSystem < Joint
+      RestSection=Marley::Utils.rest_opts_mod('section',['name','title','description','navigation'],lambda {$request[:user].class})
       def smoke
         super
-        Sequel::Model.plugin :rest_section
+        Sequel::Model.extend RestSection
       end
       module Resources
         class Menu
-          class <<self
-            attr_accessor :sections
-          end
-          include Sequel::Plugins::RestSection::ClassMethods
+          include RestSection
           def self.rest_get
-            new.section
+            new.rest_section
           end
           def self.requires_user?
             ! $request[:path].to_a.empty?
@@ -44,8 +27,8 @@ module Marley
             else
               @section_title = "#{$request[:opts][:app_name]} Main Menu"
               @section_description="Welcome to #{$request[:opts][:app_name]}, #{$request[:user].name}"
-              @section_navigation=(self.class.sections || (MR.constants - [self.class.to_s.sub(/.*::/,'').to_sym])).map do |rn|
-                if (resource=MR.const_get(rn)).respond_to?(:section) && (s=resource.section) && s.title
+              @section_navigation=(MR.constants - [self.class.to_s.sub(/.*::/,'').to_sym]).map do |rn|
+                if (resource=MR.const_get(rn)).respond_to?(:rest_section) && (s=resource.rest_section) && s.title
                   [:link,{:title => s.title, :description =>s.description, :url => "#{resource.resource_name}/section" }]
                 end
               end.compact

data/lib/joints/basic_messaging.rb

@@ -17,7 +17,7 @@ module Marley
             super << [:text,:author,RESTRICT_RO,author.to_s]
           end
           def authorize_rest_get(meth)
-            current_user_role && (meth.nil? || get_actions.include?(meth))
+            current_user_role && (meth.nil? || self.class.actions_get.include?(meth))
           end
           def authorize_rest_put(meth); false; end
           def after_initialize
@@ -38,7 +38,7 @@ module Marley
           end
         end
         class PrivateMessage < Message
-          def get_actions;['reply','reply_all'];end
+          @actions_get=['reply','reply_all']
           def rest_cols; super << :recipients; end
           def current_user_role
             super || (recipients.match(/\b#{$request[:user][:name]}\b/) && "recipient")
@@ -73,7 +73,7 @@ module Marley
           end
         end
         class Post < Message
-          def get_actions;['reply'];end
+          @actions_get=['reply']
           def current_user_role
             super || 'reader'
           end

data/lib/joints/basic_user.rb

@@ -10,9 +10,9 @@ module Marley
           attr_reader :menus
           attr_accessor :old_password,:password, :confirm_password
           def self.requires_user?
-            ! ($request[:verb]=='rest_post')
+            ! ($request[:verb]=='rest_post' || ($request[:verb]=='rest_get' && $request[:path][1]=='new'))
           end
-          def self.section
+          def self.rest_section
             ReggaeSection.new( {:title => 'User Info', :name => self.to_s.sub(/.*::/,'').underscore, :navigation => []}) if $request[:user].class == self
           end
           def write_cols;[:name,:email,:password,:confirm_password,:old_password];end

data/lib/joints/tagged_messaging.rb

@@ -39,7 +39,7 @@ module Marley
         module Message
           def rest_associations
             if ! new?
-              [ respond_to?(:public_tags) ? :public_tags : nil, respond_to?(:user_tags) ? user_tags_dataset.current_user_tags : nil].compact
+              [ respond_to?(:public_tags) ? :public_tags : nil, respond_to?(:user_tags) ? user_tags_dataset.current_user_dataset : nil].compact
             end
           end
           def new_tags
@@ -78,18 +78,18 @@ module Marley
         end
         class PrivateMessage < MJ::BasicMessaging::Resources::PrivateMessage
           attr_accessor :tags
+          @actions_get= superclass.actions_get << 'new_tags'
           @section_title='Private Messages'
           @section_name='pms'
           def self.section_navigation
             $request[:user].user_tags.map{|t| [:link,{:url => "/private_message?private_message[tag]=#{t.tag}",:title => t.tag.humanize}]}.unshift(PrivateMessage.reggae_link('new'))
           end
-          def get_actions; super << 'new_tags';end
           def rest_schema
             super << [:text, :tags, 0,tags]
           end
           def reply
             r=super
-            r.tags=(user_tags_dataset.current_user_tags.map{|t|t.tag} - RESERVED_PM_TAGS).join(',')
+            r.tags=(user_tags_dataset.current_user_dataset.map{|t|t.tag} - RESERVED_PM_TAGS).join(',')
             r
           end
           def after_create
@@ -104,7 +104,7 @@ module Marley
           def self.section_navigation
             MR::Tag.filter(:user_id => nil).map{|t| [:link,{:url => "/post?post[tag]=#{t.tag}",:title => t.tag.humanize}]}.unshift([:link,{:url => '/post?post[untagged]=true',:title => 'Untagged Messages'}]).unshift(Post.reggae_link('new'))
           end
-          def get_actions;(super << 'new_user_tags') << 'new_tags';end
+          @actions_get=(superclass.actions_get << 'new_user_tags') << 'new_tags'
           def rest_schema
             (super << [:text, :tags, 0,tags] ) << [:text, :my_tags, 0,my_tags] 
           end

data/lib/joints/tagging.rb

@@ -5,7 +5,7 @@ module Marley
         class Tag < Sequel::Model
           def self.tagging_for(klass, user_class=nil,join_table=nil)
             current_user_tags=Module.new do
-                def current_user_tags
+                def current_user_dataset
                   filter(:tags__user_id => $request[:user][:id])
                 end
               end
@@ -13,22 +13,16 @@ module Marley
             join_table||=:"#{tagged_class.table_name}_tags"
             klass_key=:"#{tagged_class.table_name.to_s.singularize}_id"
             tag_key=:tag_id
-            attr_accessor klass_key
             if user_class
               UserTag.many_to_many klass.underscore.to_sym,:class => "Marley::Resources::#{klass}", :join_table => join_table,:left_key => tag_key,:right_key => klass_key,:extend => current_user_tags
-              tagged_class.many_to_many :user_tags, :class => 'Marley::Resources::UserTag',:join_table => join_table,:left_key => klass_key,:right_key => tag_key, :extend => current_user_tags
+              tagged_class.many_to_many :user_tags, :class => 'Marley::Resources::UserTag',:join_table => join_table,:left_key => klass_key,:right_key => tag_key, :extend => [current_user_tags,Marley::RestActions]
               Marley::Resources.const_get(user_class).one_to_many :user_tags, :class => 'Marley::Resources::UserTag'
               UserTag.many_to_one user_class.underscore.to_sym,:class => "Marley::Resources::#{user_class}"
             else
               PublicTag.many_to_many klass.underscore.to_sym,:class => "Marley::Resources::#{klass}", :join_table => join_table,:left_key => tag_key,:right_key => klass_key
-              tagged_class.many_to_many :public_tags,:class => "Marley::Resources::PublicTag",:join_table => join_table,:left_key => klass_key,:right_key => tag_key
+              tagged_class.many_to_many :public_tags,:class => "Marley::Resources::PublicTag",:join_table => join_table,:left_key => klass_key,:right_key => tag_key, :extend => Marley::RestActions
             end
           end
-          def to_a
-            a=super
-            a[1][:delete_action]='remove_parent'
-            a
-          end
           def validate
             validates_presence :tag
             validates_unique [:tag,:user_id]
@@ -50,9 +44,11 @@ module Marley
         end
         class PublicTag < Tag
           set_dataset DB[:tags].filter(:user_id => nil)
+          @actions_delete='remove_parent'
         end
         class UserTag < Tag
           set_dataset DB[:tags].filter(~{:user_id => nil})
+          @actions_delete='remove_parent'
         end
       end
     end

data/lib/marley.rb

@@ -1,13 +1,15 @@
 #!/usr/bin/ruby
 require 'json/ext'
 require 'json/add/core'
+require 'marley/reggae'
+require 'marley/utils'
 require 'rack'
 require 'rack/auth/basic'
 require 'rack/builder'
+require 'sequel'
 require 'sequel/plugins/rest_convenience'
 require 'sequel/plugins/rest_auth'
 require 'marley/controllers'
-require 'marley/reggae'
 require 'logger'
 Sequel.extension :inflector
 
@@ -20,34 +22,17 @@ Sequel::Model.plugin :timestamps, :create => :date_created, :update => :date_upd
 log_fn='log/marley.log'
 $log=Logger.new(File.exists?(log_fn) ? log_fn : $stdout) 
 
-# This is the main Marley namespace
 module Marley 
   JOINT_DIRS=[File.expand_path("joints/",File.dirname(__FILE__)),"#{Dir.pwd}/joints"]
-  # @see config
   DEFAULT_OPTS={:http_auth => true,:app_name => 'Application',:port => 1620,:default_user_class => :User, :auth_class => :User,:default_resource => 'Menu', :server => 'thin'}
   RESP_CODES={'get' => 200,'post' => 201,'put' => 204,'delete' => 204}
   
-  # All constants in the Resources namespace should refer to public resources accessible to clients, subject, of course, to authentication/authorization.
-  #
-  # Resources MUST respond to one or more of #controller, #rest_get, #rest_post, #rest_put, #rest_delete
-  #
-  # If a Resource implements a #controller method, the method MUST return an object which responds to one or more of #rest_get, #rest_post, #rest_put, #rest_delete
   module Resources 
   end
-  # The default namespace for Joints. Joints MUST implement a #smoke method
   module Joints
   end
   require 'marley/joint' #this needs to happen after Marley::Resources is defined
   
-  # Override default Marley configuration
-  # @param [Hash] opts A hash containing Marley configuration options
-  # @option opts [Boolean] :http_auth Whether or not to use http authentication
-  # @option opts [String] :app_name Currently used by Jamaica to set page title
-  # @option opts [Number] :port Port on which to run the server
-  # @option opts [Object] :default_user_class The default class of the new user assigned to $request[:user] if no actual user is authenticated
-  # @option opts [Object] :auth_class The class used to authenticate requests.  MUST respond to #authenticate
-  # @option opts [Object] :default_resource The resource called in response to a request to '/'
-  # @option opts [String] :server  the Rack web server to be used.
   def self.config(opts=nil)
     @marley_opts||=DEFAULT_OPTS
     @marley_opts.merge!(opts) if opts
@@ -55,17 +40,15 @@ module Marley
     @marley_opts
   end
   
-  # Loads a joint and and calls its #smoke method
-  # @param [String] joint_name The name of the joint to load and smoke - additional paramters passed through to the joint itself
   def self.joint(joint_name, *opts)
-    joint_d=JOINT_DIRS.find {|d| File.exists?("#{d}/#{joint_name}.rb") }
-    require "#{joint_d}/#{joint_name}"
-    @marley_opts && @marley_opts[:client] && @marley_opts[:client].joint(joint_d,joint_name)
-    joint=Marley::Joints.const_get(joint_name.camelize).new(*opts).smoke
+    unless Marley::Joints.constants.include?(joint_name.camelize)
+      joint_d=JOINT_DIRS.find {|d| File.exists?("#{d}/#{joint_name}.rb") }
+      require "#{joint_d}/#{joint_name}"
+      @marley_opts && @marley_opts[:client] && @marley_opts[:client].joint(joint_d,joint_name)
+    end
+    Marley::Joints.const_get(joint_name.camelize).new(*opts).smoke
   end
 
-  # Runs the server
-  # @param (see #config)
   def self.run(opts={})
     @marley_opts||=DEFAULT_OPTS
     marley_opts=@marley_opts.merge!(opts)
@@ -75,7 +58,7 @@ module Marley
       run(Marley::Router.new(marley_opts))
     }.to_app,{:Port => @marley_opts[:port]})
   end
-  class Router  #the default Marley router.  Creates the $request object, locates the resource requested and calls either its controller's or its own rest verb method
+  class Router  
     def initialize(opts={},app=nil)
       @opts=DEFAULT_OPTS.merge(opts)
     end
@@ -104,16 +87,23 @@ module Marley
       raise RoutingError unless Resources.constants.include?(rn)
       @resource=Resources.const_get(rn)
       raise AuthenticationError if @opts[:http_auth] && @resource.respond_to?('requires_user?') && @resource.requires_user? && $request[:user].new?
-      @controller=@resource.respond_to?($request[:verb]) ? @resource : @resource.controller
+      @controller=nil
+      @controller=@resource.controller if @resource.respond_to?(:controller)
+      @controller=@resource if @resource.respond_to?($request[:verb]) 
+      raise RoutingError unless @controller
       json=@controller.send($request[:verb]).to_json
       html=@opts[:client] ? @opts[:client].to_s(json) : json
       resp_code=RESP_CODES[verb]
       headers||={'Content-Type' => "#{$request[:content_type]}; charset=utf-8"}
       [resp_code,headers,$request[:content_type].match(/json/) ? json : html]
     rescue Sequel::ValidationFailed
-      ValidationError.new($!.errors).response
+      ValidationError.new($!.errors).to_a
     rescue
-      ($!.class.new.respond_to?(:response) ?  $!.class : MarleyError).new.response
+      if $!.class.superclass==MarleyError
+        $!.to_a
+      else
+        p $!,$!.backtrace
+      end
     ensure
       $log.info $request.merge({:request => nil,:user => $request[:user] ? $request[:user].name : nil})
     end
@@ -129,7 +119,7 @@ module Marley
     def log_error
       $log.fatal("#$!.message}\n#{$!.backtrace}")
     end
-    def response
+    def to_a
       log_error
       json=[:error,{:error_type => self.class.name.underscore.sub(/_error$/,'').sub(/^marley\//,''),:description => self.class.description, :error_details => self.class.details}].to_json
       self.class.headers||={'Content-Type' => "#{$request[:content_type]}; charset=utf-8"}
@@ -166,11 +156,6 @@ module Marley
       $log.fatal("path:#{$request[:path]}\n   msg:#{$!.message}\n   backtrace:#{$!.backtrace}")
     end
   end
-  module Utils
-    def self.hash_keys_to_syms(hsh)
-      hsh.inject({}) {|h,(k,v)| h[k.to_sym]= v.class==Hash ? hash_keys_to_syms(v) : v;h }
-    end
-  end
 end
   MR=Marley::Resources
   MJ=Marley::Joints

data/lib/marley/joint.rb

@@ -5,6 +5,9 @@ module Marley
     #    - ClassMethods - Modules within this module will extend any constant in Marley::Resources with the same name.
     #    - InstanceMethods - Modules within this module will append their features to any constant in Marley::Resources with the same name. 
     class Joint
+      #def self.provides(*args)
+      #  [:resources,:class_methods,:]
+      #end
       def initialize(opts={})
         config(opts)
       end
@@ -20,6 +23,7 @@ module Marley
             end
           end
         end
+        self
       end
       def config(opts)
         @opts=(@opts || {}).merge(opts)

data/lib/marley/reggae.rb

@@ -1,4 +1,12 @@
 
+RESTRICT_HIDE=1
+RESTRICT_RO=2
+RESTRICT_REQ=4
+TYPE_INDEX=0
+NAME_INDEX=1
+RESTRICTIONS_INDEX=2
+require 'sequel'
+Sequel.extension :inflector
 module Marley
   # @see file:reggae.ebnf for Raggae sytax
   class Reggae < Array
@@ -21,7 +29,7 @@ module Marley
     attr_accessor :properties,:contents
     # @param [Array] *args an array in Reggae syntax
     def initialize(*args)
-      super
+      super 
       if is_resource?
         @resource_type=self[0]=self[0].to_sym
         self[1]=Utils.hash_keys_to_syms(self[1]) if self[1].class==Hash
@@ -29,11 +37,11 @@ module Marley
         @contents=self[2 .. -1]
         self.class.mk_prop_methods
       else
-        replace(map {|r| Reggae.new(r).to_resource})
+        replace(map {|r| r.class==Array ? Reggae.new(r).to_resource : r})
       end
     end
     def is_resource?
-      [String, Symbol].include?(self[0].class) && self[1].class==Hash
+      [String, Symbol].include?(self[0].class) && Marley.constants.include?("reggae_#{self[0]}".camelcase)
     end
     def contents=(*args)
       self[2]=*args
@@ -55,7 +63,7 @@ module Marley
     def initialize(*args)
       @resource_type=self.class.to_s.sub(/.*Reggae/,'').underscore.to_sym
       if args[0].class==Hash
-        initialize [@resource_type,args[0]]
+        initialize [@resource_type,args[0],args[1 .. -1]]
       else
         super
       end
@@ -71,7 +79,7 @@ module Marley
     properties :title,:description,:url
   end
   class ReggaeInstance < ReggaeResource
-    properties :name,:new_rec,:schema,:search,:url,:get_actions,:delete_action
+    properties :name,:new_rec,:schema,:search,:url,:actions
     attr_accessor :schema
     def initialize(*args)
       super
@@ -84,9 +92,6 @@ module Marley
         params
       end
     end
-    def instance_action_url(action_name)
-      "#{url}#{action_name}" if get_actions.include?(action_name.to_s)
-    end
     def col_value(col_name,col_value=nil)
       col=@schema[col_name]
       col.col_value=col_value if col_value
@@ -98,7 +103,7 @@ module Marley
     end
   end
   class ReggaeInstanceList < ReggaeResource
-    properties :name,:description,:get_actions,:delete_action,:items
+    properties :name,:description,:actions,:items
     #not implemented yet
   end
   class ReggaeMsg < ReggaeResource
@@ -109,7 +114,7 @@ module Marley
   end
   class ReggaeSchema < Array
     def initialize(*args)
-      super
+      super 
       replace(map{|spec| ReggaeColSpec.new(spec)})
     end
     def [](i)