dao 0.0.0 → 2.0.0

data/README

@@ -0,0 +1,35 @@
+NAME
+  dao
+
+SYNOPSIS
+  a library for structuring rails applications using the 'data access object' pattern
+
+DESCRITPION
+  stay tuned...
+
+ISSUES ADRESSED
+  . testability
+  . documentability
+  . being able to reason about code
+  . reasoning about caching
+  . avoiding duplicating logic in html/api
+  . avoid N+1 in view
+  . avoid design issues with REST (delete(1,2,3))
+  . nested attributes trivally
+  . lack of domain (current_user)
+  . easily optimize queries later
+  . magic
+
+READING
+  http://www.paperplanes.de/2010/5/7/activerecord_callbacks_ruined_my_life.html
+  http://best-practice-software-engineering.ifs.tuwien.ac.at/patterns/dao.html
+  http://www.codefutures.com/data-access-object/
+  http://java.sun.com/blueprints/corej2eepatterns/Patterns/DataAccessObject.html
+
+INSTALL
+  gem 'dao', :path => File.expand_path('..') ### Gemfile
+  rails generate dao api
+  vim -o app/api.rb app/controllers/api_controller.rb
+  curl --silent http://0.0.0.0:3000/api
+  curl --silent http://0.0.0.0:3000/api/ping
+    

data/Rakefile

@@ -1,7 +1,7 @@
 This.rubyforge_project = 'codeforpeople'
 This.author = "Ara T. Howard"
 This.email = "ara.t.howard@gmail.com"
-This.homepage = "http://github.com/ahoward/#{ This.lib }/tree/master"
+This.homepage = "http://github.com/ahoward/#{ This.lib }"
 
 
 task :default do
@@ -26,7 +26,7 @@ def run_tests!(which = nil)
         
   div = ('=' * 119)
   line = ('-' * 119)
-  helper = "-r ./test/helper.rb" if test(?e, "./test/helper.rb")
+  helper = nil #"-r ./test/helper.rb" if test(?e, "./test/helper.rb")
 
   test_rbs.each_with_index do |test_rb, index|
     testno = index + 1
@@ -126,6 +126,9 @@ task :gemspec do
             spec.test_files = #{ test_files.inspect }
 
           # spec.add_dependency 'lib', '>= version'
+            spec.add_dependency 'map'
+            spec.add_dependency 'tagz'
+            spec.add_dependency 'yajl-ruby'
 
             spec.extensions.push(*#{ extensions.inspect })
 
@@ -139,7 +142,7 @@ task :gemspec do
     end
 
   Fu.mkdir_p(This.pkgdir)
-  This.gemspec = File.join(This.pkgdir, "gemspec.rb")
+  This.gemspec = File.join(This.dir, "#{ This.lib }.gemspec") #File.join(This.pkgdir, "gemspec.rb")
   open("#{ This.gemspec }", "w"){|fd| fd.puts(template)}
 end
 

data/TODO

@@ -0,0 +1,37 @@
+todo:
+
+  route -> path??
+
+  - nested AR conversions
+      to_dao(:a, :b => [:foo, :bar])
+
+  - AR as_dao contains the model type/class.name
+
+
+done:
+    - engine-ify the rails stuff?  or what
+      - generator api
+      - controller
+      - helper
+      - json/pretty fix baked in? (yajl might simply this...)
+  - description/doc logic
+  - api.index
+  - to_alpo -> to_dao
+  - tests!
+  - #call auto parses data iff appropriate
+      @result = api.read.call('/posts/new(', params)  ### check keys for '/posts/new'
+  - re-visit how parameters are parsed, perhaps we just use rack?
+  - next 'data' => {}
+  - check the db layer
+  - make sure one can call route based method (/foo/:bar) methods with params...
+  - Path==Route ??
+  - add result.rb, params.rb
+  - name -> path
+  - tagz for html methods?
+  - data aquires the name/path of the method?
+  - endpoints are objects that respond to call.  namespaces respond to call.
+    api responds to call
+  - nested namespaces
+  - routing for path_info + mode 
+      route(path_info, :mode => mode, :params => params)
+  - call() on namespaces AND endpoints... why?

data/dao.gemspec

@@ -0,0 +1,30 @@
+## dao.gemspec
+#
+
+Gem::Specification::new do |spec|
+  spec.name = "dao"
+  spec.version = "2.0.0"
+  spec.platform = Gem::Platform::RUBY
+  spec.summary = "dao"
+  spec.description = "description: dao kicks the ass"
+
+  spec.files = ["dao.gemspec", "db", "db/dao.yml", "lib", "lib/dao", "lib/dao/active_record.rb", "lib/dao/api", "lib/dao/api/context.rb", "lib/dao/api/dsl.rb", "lib/dao/api/endpoints.rb", "lib/dao/api/initializers.rb", "lib/dao/api/modes.rb", "lib/dao/api.rb", "lib/dao/blankslate.rb", "lib/dao/data.rb", "lib/dao/db.rb", "lib/dao/endpoint.rb", "lib/dao/engine.rb", "lib/dao/errors.rb", "lib/dao/exceptions.rb", "lib/dao/form.rb", "lib/dao/mode.rb", "lib/dao/mongo_mapper.rb", "lib/dao/params.rb", "lib/dao/path.rb", "lib/dao/rails", "lib/dao/rails/app", "lib/dao/rails/app/api.rb", "lib/dao/rails/app/controllers", "lib/dao/rails/app/controllers/api_controller.rb", "lib/dao/rails/engine", "lib/dao/rails/lib", "lib/dao/rails/lib/generators", "lib/dao/rails/lib/generators/dao", "lib/dao/rails/lib/generators/dao/api_generator.rb", "lib/dao/rails/lib/generators/dao/dao_generator.rb", "lib/dao/rails/lib/generators/dao/templates", "lib/dao/rails/lib/generators/dao/templates/api.rb", "lib/dao/rails/lib/generators/dao/templates/api_controller.rb", "lib/dao/rails/lib/generators/dao/USAGE", "lib/dao/rails.rb", "lib/dao/result.rb", "lib/dao/slug.rb", "lib/dao/status.rb", "lib/dao/stdext.rb", "lib/dao/support.rb", "lib/dao/validations.rb", "lib/dao.rb", "Rakefile", "README", "sample", "sample/rails_app", "sample/rails_app/app", "sample/rails_app/app/api.rb", "sample/rails_app/app/controllers", "sample/rails_app/app/controllers/api_controller.rb", "sample/rails_app/app/controllers/application_controller.rb", "sample/rails_app/app/helpers", "sample/rails_app/app/helpers/application_helper.rb", "sample/rails_app/app/mailers", "sample/rails_app/app/models", "sample/rails_app/app/views", "sample/rails_app/app/views/layouts", "sample/rails_app/app/views/layouts/application.html.erb", "sample/rails_app/config", "sample/rails_app/config/application.rb", "sample/rails_app/config/boot.rb", "sample/rails_app/config/database.yml", "sample/rails_app/config/environment.rb", "sample/rails_app/config/environments", "sample/rails_app/config/environments/development.rb", "sample/rails_app/config/environments/production.rb", "sample/rails_app/config/environments/test.rb", "sample/rails_app/config/initializers", "sample/rails_app/config/initializers/backtrace_silencers.rb", "sample/rails_app/config/initializers/inflections.rb", "sample/rails_app/config/initializers/mime_types.rb", "sample/rails_app/config/initializers/secret_token.rb", "sample/rails_app/config/initializers/session_store.rb", "sample/rails_app/config/locales", "sample/rails_app/config/locales/en.yml", "sample/rails_app/config/routes.rb", "sample/rails_app/config.ru", "sample/rails_app/db", "sample/rails_app/db/development.sqlite3", "sample/rails_app/db/seeds.rb", "sample/rails_app/doc", "sample/rails_app/doc/README_FOR_APP", "sample/rails_app/Gemfile", "sample/rails_app/Gemfile.lock", "sample/rails_app/lib", "sample/rails_app/lib/tasks", "sample/rails_app/log", "sample/rails_app/log/development.log", "sample/rails_app/log/production.log", "sample/rails_app/log/server.log", "sample/rails_app/log/test.log", "sample/rails_app/public", "sample/rails_app/public/404.html", "sample/rails_app/public/422.html", "sample/rails_app/public/500.html", "sample/rails_app/public/favicon.ico", "sample/rails_app/public/images", "sample/rails_app/public/images/rails.png", "sample/rails_app/public/index.html", "sample/rails_app/public/javascripts", "sample/rails_app/public/javascripts/application.js", "sample/rails_app/public/javascripts/controls.js", "sample/rails_app/public/javascripts/dragdrop.js", "sample/rails_app/public/javascripts/effects.js", "sample/rails_app/public/javascripts/prototype.js", "sample/rails_app/public/javascripts/rails.js", "sample/rails_app/public/robots.txt", "sample/rails_app/public/stylesheets", "sample/rails_app/Rakefile", "sample/rails_app/README", "sample/rails_app/script", "sample/rails_app/script/rails", "sample/rails_app/test", "sample/rails_app/test/fixtures", "sample/rails_app/test/functional", "sample/rails_app/test/integration", "sample/rails_app/test/performance", "sample/rails_app/test/performance/browsing_test.rb", "sample/rails_app/test/test_helper.rb", "sample/rails_app/test/unit", "sample/rails_app/tmp/cache", "sample/rails_app/tmp/pids", "sample/rails_app/tmp/sessions", "sample/rails_app/tmp/sockets", "sample/rails_app/vendor", "sample/rails_app/vendor/plugins", "test", "test/dao_test.rb", "test/helper.rb", "test/testing.rb", "test/units", "TODO"]
+  spec.executables = []
+  
+  spec.require_path = "lib"
+
+  spec.has_rdoc = true
+  spec.test_files = nil
+
+# spec.add_dependency 'lib', '>= version'
+  spec.add_dependency 'map'
+  spec.add_dependency 'tagz'
+  spec.add_dependency 'yajl-ruby'
+
+  spec.extensions.push(*[])
+
+  spec.rubyforge_project = "codeforpeople"
+  spec.author = "Ara T. Howard"
+  spec.email = "ara.t.howard@gmail.com"
+  spec.homepage = "http://github.com/ahoward/dao"
+end

data/db/dao.yml

@@ -0,0 +1,8 @@
+--- 
+"42": {}
+
+users: 
+  "42": 
+    a: :b
+    time: 2011-01-26 13:27:36.996654 -07:00
+    id: 42

data/lib/dao.rb

@@ -1,9 +1,88 @@
-module Dao
+# built-ins
+#
+  require 'enumerator'
+  #require 'fileutils'
+  #require 'pathname'
+  #require 'yaml'
+  #require 'yaml/store'
 
-  def Dao.version
-    '0.0.0'
+# gems
+#
+  begin
+    require 'rubygems'
+  rescue LoadError
+    nil
   end
 
-end
+  if defined?(gem)
+    gem('map', '~> 2.2.2')
+    gem('tagz', '~> 8.0')
+    gem('yajl-ruby', '~> 0.7.9')
+  end
+
+  require 'map'
+  require 'tagz'
+  require 'yajl'
+
+# dao libs
+#
+  module Dao
+    Version = '2.0.0' unless defined?(Version)
+
+    def version
+      Dao::Version
+    end
+
+    def libdir(*args, &block)
+      @libdir ||= File.expand_path(__FILE__).sub(/\.rb$/,'')
+      args.empty? ? @libdir : File.join(@libdir, *args)
+    ensure
+      if block
+        begin
+          $LOAD_PATH.unshift(@libdir)
+          block.call()
+        ensure
+          $LOAD_PATH.shift()
+        end
+      end
+    end
+
+    def load(*libs)
+      libs = libs.join(' ').scan(/[^\s+]+/)
+      Dao.libdir{ libs.each{|lib| Kernel.load(lib) } }
+    end
+
+    extend(Dao)
+  end
 
-DAO = Dao
+  Dao.load %w[
+    blankslate.rb
+    exceptions.rb
+    support.rb
+    slug.rb
+    stdext.rb
+
+    result.rb
+    params.rb
+    status.rb
+    data.rb
+    form.rb
+    errors.rb
+    validations.rb
+
+    mode.rb
+    path.rb
+    endpoint.rb
+    api.rb
+
+
+    rails.rb
+    active_record.rb
+    mongo_mapper.rb
+  ]
+
+  Dao.autoload(:Db, Dao.libdir('db.rb'))
+
+  unless defined?(D)
+    D = Dao
+  end

data/lib/dao/active_record.rb

@@ -0,0 +1,76 @@
+begin
+  ActiveRecord
+  ActiveRecord::Base
+rescue NameError
+  nil
+end
+
+if defined?(ActiveRecord)
+
+  module ActiveRecord
+    module ToDao
+      module ClassMethods
+        def to_dao(*args)
+
+          @to_dao ||= (
+            column_names # + reflect_on_all_associations.map(&:name)
+          ).map{|name| name.to_s}
+
+          unless args.empty?
+            @to_dao.clear
+            args.flatten.compact.each do |arg|
+              @to_dao.push(arg.to_s)
+            end
+            @to_dao.uniq!
+            @to_dao.map!{|name| name.to_s}
+          end
+
+          @to_dao
+        end
+
+        def to_dao=(*args)
+          to_dao(*args)
+        end
+      end
+
+      module InstanceMethods
+        def to_dao(*args)
+          hash = Dao.hash
+          model = self.class
+
+          attrs = args.empty? ? model.to_dao : args
+
+          attrs.each do |attr|
+            value = send(attr)
+
+            if value.respond_to?(:to_dao)
+              hash[attr] = value.to_dao
+              next
+            end
+
+            if value.is_a?(Array)
+              hash[attr] = value.map{|val| val.respond_to?(:to_dao) ? val.to_dao : val}
+              next
+            end
+
+            hash[attr] = value
+          end
+
+          if hash.has_key?(:_id) and not hash.has_key?(:id)
+            hash[:id] = hash[:_id]
+          end
+
+          hash
+        end
+        alias_method 'to_h', 'to_dao'
+        #alias_method 'to_map', 'to_dao' ### HACK
+      end
+    end
+
+    if defined?(ActiveRecord::Base)
+      ActiveRecord::Base.send(:extend, ToDao::ClassMethods)
+      ActiveRecord::Base.send(:include, ToDao::InstanceMethods)
+    end
+  end
+
+end

data/lib/dao/api.rb

@@ -0,0 +1,9 @@
+module Dao
+  class Api
+    Dao.load 'api/initializers.rb'
+    Dao.load 'api/modes.rb'
+    Dao.load 'api/context.rb'
+    Dao.load 'api/endpoints.rb'
+    Dao.load 'api/dsl.rb'
+  end
+end

data/lib/dao/api/context.rb

@@ -0,0 +1,38 @@
+module Dao
+  class Context
+    Attrs = %w( api endpoint params result method args )
+    Attrs.each{|attr| attr_accessor(attr)}
+
+    def initialize(*args, &block)
+      options = Dao.options_for!(args)
+
+      api = options[:api]
+      endpoint = options[:endpoint]
+      params = options[:params]
+    
+      params = Params.for(:api => api, :endpoint => endpoint, :params => params)
+      result = Result.new(:api => api, :endpoint => endpoint, :params => params)
+      params.result = result
+
+      method = endpoint.method.bind(api)
+      args = [params, result].slice(0, method.arity)
+
+      self.api = api
+      self.endpoint = endpoint
+      self.params = params
+      self.result = result
+      self.method = method
+      self.args = args
+    end
+
+    def call()
+      method.call(*args)
+    end
+
+    def update(options = {})
+      options.each do |key, val|
+        send("#{ key }=", val)
+      end
+    end
+  end
+end

data/lib/dao/api/dsl.rb

@@ -0,0 +1,50 @@
+module Dao
+  class Api
+    class DSL < BlankSlate
+      attr_accessor :api
+
+      def initialize(api)
+        @api = api
+        #@evaluate = Object.instance_method(:instance_eval).bind(self)
+      end
+
+      def evaluate(&block)
+        #@evaluate.call(&block)
+        @api.module_eval(&block)
+      ensure
+        #no_docs_left_on_stack!
+      end
+
+      def no_docs_left_on_stack!
+        raise "no endpoint for #{ docs.inspect }" unless docs.empty?
+      end
+
+      %w( endpoint doc docs description desc ).each do |method|
+        module_eval <<-__, __FILE__, __LINE__ - 1
+
+          def #{ method }(*args, &block)
+            api.#{ method }(*args, &block)
+          end
+
+        __
+      end
+    end
+
+    class << Api
+      def evaluate(&block)
+        @dsl ||= DSL.new(api=self)
+        @dsl.evaluate(&block)
+      end
+    end
+  end
+
+  def Dao.api(&block)
+    if block
+      api = Class.new(Api)
+      api.evaluate(&block)
+      api
+    else
+      Api
+    end
+  end
+end

data/lib/dao/api/endpoints.rb

@@ -0,0 +1,190 @@
+module Dao
+  class Api
+    class << Api
+      def endpoints
+        @endpoints ||= Map.new
+      end
+
+      def endpoint(path, &block)
+        api = self
+        path = Path.new(path)
+
+        method =
+          module_eval{ 
+            define_method(path + '/endpoint', &block)
+            instance_method(path + '/endpoint')
+          }
+
+
+        endpoint = Endpoint.new(
+          'api' => api,
+          'path' => path,
+          'method' => method,
+          'doc' => docs.pop
+        )
+
+        endpoints[path] = endpoint
+      end
+
+      def description(string)
+        doc(:description => Dao.unindent(string))
+      end
+      alias_method('desc', 'description')
+
+      def doc(*args)
+        docs.push(Map[:description, nil]) if docs.empty?
+        doc = docs.last
+        options = Dao.options_for!(args)
+        if options.empty?
+          options[:description] = args.join(' ')
+        end
+        doc.update(options)
+        doc
+      end
+
+      def docs
+        @docs ||= []
+      end
+
+      def index
+        index = Map.new
+        endpoints.each do |path, endpoint|
+          index[path] = endpoint.doc || {'description' => path}
+        end
+        index
+      end
+    end
+
+    def call(path = '/index', params = {})
+      api = self
+      path = Path.new(path)
+      endpoint = endpoints[path]
+      raise(NameError, path) unless endpoint
+
+      params = parse_params(params, path)
+
+      context = Context.new(
+        :api => api,
+        :endpoint => endpoint,
+        :params => params
+      )
+
+      callstack(context) do
+        catching(:result){ context.call() }
+      end
+
+      context.result
+    end
+
+    def index
+      self.class.index
+    end
+
+    def parse_params(params, path)
+      return params if params.is_a?(Params)
+      re = %r/^#{ Regexp.escape(path) }/
+      params.each do |key, val|
+        return Params.parse(path, params) if key =~ re
+      end
+      return params
+    end
+
+    def endpoints
+      self.class.endpoints
+    end
+
+    def context
+      callstack.last
+    end
+
+    def result
+      context.result
+    end
+
+    def status(*args, &block)
+      result.status(*args, &block)
+    end
+
+    def data
+      result.data
+    end
+
+    def errors
+      result.errors
+    end
+
+    def params
+      result.params
+    end
+
+    def validations
+      result.validations
+    end
+
+    def validates(*args, &block)
+      result.validates(*args, &block)
+    end
+
+    def validate
+      result.validate
+    end
+
+    def valid?
+      result.valid?
+    end
+
+    def validate!
+      result.validate!
+    end
+
+    def valid!
+      result.valid!
+    end
+
+    def callstack(context = nil, &block)
+      @callstack ||= []
+
+      if block and context
+        begin
+          @callstack.push(context)
+          return block.call()
+        ensure
+          @callstack.pop
+        end
+      else
+        @callstack
+      end
+    end
+
+    def catching(label = :result, &block)
+      @catching ||= []
+
+      if block
+        begin
+          @catching.push(label)
+          catch(label, &block)
+        ensure
+          @catching.pop
+        end
+      else
+        @catching.last
+      end
+    end
+
+    def catching_results(&block)
+      catching(:result, &block)
+    end
+
+    def catching?
+      catching
+    end
+
+    def catching_results?
+      catching == :result
+    end
+
+    def respond_to?(*args)
+      super(*args) || super(Path.absolute_path_for(*args))
+    end
+  end
+end