nested 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f19e9d429c1ae06debc557e262539cf5817e1cde
+  data.tar.gz: 400c5102ec072ff320eec74aecff61dc8379e3d1
+SHA512:
+  metadata.gz: 645f64ca4ad1229866c346ca2db9ff018272b4bccd9fd6df1245eb36453398a45b4d3e7396370dabec2f23250415323d4750154d3ab706ea70d9124d21240823
+  data.tar.gz: 8f839e12ec5cd696efb49a6d5412471032f6f94adff0615eee26518885605799b0dda229bbfd015d409a056ab349bfb12d2a0a1b46fb6aacc0936476cc18206d

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/Gemfile

@@ -0,0 +1,6 @@
+ruby "2.0.0"
+
+source 'https://rubygems.org'
+
+gem "activesupport"
+gem "mocha"

data/Gemfile.lock

@@ -0,0 +1,26 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.0.0)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    atomic (1.1.14)
+    i18n (0.6.5)
+    metaclass (0.0.1)
+    minitest (4.7.5)
+    mocha (0.14.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.8.2)
+    thread_safe (0.1.3)
+      atomic
+    tzinfo (0.3.38)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  mocha

data/Rakefile

@@ -0,0 +1,13 @@
+# encoding: UTF-8
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+desc "Run tests"
+Rake::TestTask.new(:test) do |t|
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = true
+end
+
+# Make test the default task.
+task :default => :test

data/lib/nested.rb

@@ -0,0 +1,270 @@
+module Nested
+
+  class OneWithNameInManyError < StandardError
+  end
+
+  class ManyInManyError < StandardError
+  end
+
+  class SingletonAndCollectionError < StandardError
+  end
+
+  class Resource
+    FETCH =  ->(resource, ctrl) do
+      raise "implement fetch for resource #{resource.name}"  unless resource.parent
+      raise "implement fetch for singleton #{resource.name}" if resource.singleton?
+
+      parent_resource = resource.parent
+      parent_obj = ctrl.instance_variable_get("@#{parent_resource.instance_variable_name}")
+
+      if resource.name
+        scope = parent_obj.send(resource.name.to_s.pluralize.to_sym)
+        resource.collection? ? scope : scope.where(id: ctrl.params["#{resource.name.to_s.singularize}_id"]).first
+      else
+        parent_obj.where(id: ctrl.params["#{parent_resource.name.to_s.singularize}_id"]).first
+      end
+    end
+
+    attr_reader :name, :parent, :actions, :resources
+
+    def initialize(sinatra, name, singleton, collection, parent)
+      raise SingletonAndCollectionError.new if singleton && collection
+
+      @sinatra = sinatra
+      @name = name
+      @singleton = singleton
+      @collection = collection
+      @parent = parent
+      @resources = []
+      @actions = []
+    end
+
+    def singleton?
+      @singleton == true
+    end
+
+    def member?
+      !singleton? && !collection?
+    end
+
+    def collection?
+      @collection == true
+    end
+
+    def fetch(&block)
+      @__fetch = block
+    end
+
+    def fetch_object(ctrl)
+      (@__fetch || FETCH).call(self, ctrl)
+    end
+
+    def route(args={})
+      "".tap do |r|
+        r << @parent.route(args) if @parent
+
+        if singleton?
+          r << "/" + @name.to_s.singularize
+        elsif collection?
+          r << "/" + @name.to_s.pluralize
+        else
+          if @name
+            r << "/" + @name.to_s.pluralize
+          end
+          r << "/"
+          key = ((@name || @parent.name).to_s.singularize + "_id").to_sym
+
+          if args.key?(key)
+            r << args[key].to_s
+          else
+            r << ":#{key}"
+          end
+        end
+      end
+    end
+
+    def get(action=nil, &block)
+      create_sinatra_route :get, action, &(block || get_default)
+    end
+
+    def get_default
+      ->(resource) { instance_variable_get("@#{resource.instance_variable_name}") }
+    end
+
+    def post(action=nil, &block)
+      create_sinatra_route :post, action, &block
+    end
+
+    def put(action=nil, &block)
+      create_sinatra_route :put, action, &block
+    end
+
+    def delete(action=nil, &block)
+      create_sinatra_route :delete, action, &block
+    end
+
+    def singleton(name, &block)
+      child_resource(name, true, false, &block)
+    end
+
+    def many(name, &block)
+      raise ManyInManyError.new "do not nest many in many" if collection?
+      child_resource(name, false, true, &block)
+    end
+
+    def one(name=nil, &block)
+      raise OneWithNameInManyError.new("call one (#{name}) without name argument when nested in a many (#{@name})") if name && collection?
+      child_resource(name, false, false, &block)
+    end
+
+    def child_resource(name, singleton, collection, &block)
+       Resource.new(@sinatra, name, singleton, collection, self)
+        .tap{|r| r.instance_eval(&block)}
+        .tap{|r| @resources << r}
+    end
+
+    def instance_variable_name
+      @name.to_s.send(collection? ? :pluralize : :singularize).to_sym
+    end
+
+    def parents
+      (@parent ? @parent.parents + [@parent] : [])
+    end
+
+    def self_and_parents
+      (self.parents + [self]).reverse
+    end
+
+    def create_sinatra_route(method, action, &block)
+      @actions << {method: method, actions: action}
+
+      resource = self
+
+      puts "sinatra router [#{method}] #{@sinatra.prefix}#{resource.route}"
+
+      @sinatra.send(method, resource.route) do
+        content_type :json
+
+        resource.self_and_parents.reverse.each do |res|
+          resource_obj = res.fetch_object(self)
+
+          puts "set @#{res.instance_variable_name} to #{resource_obj.inspect} for #{self}"
+          instance_variable_set("@#{res.instance_variable_name}", resource_obj)
+        end
+
+        case response = instance_exec(resource, &block)
+          when String then  response
+          else              response.to_json
+        end
+      end
+    end
+  end
+
+  module Angular
+    def self.extended(base)
+      base.send(:extend, Nested::Angular::Sinatra)
+    end
+
+    module Sinatra
+      def create_resource(name, singleton, collection, &block)
+        angularize(super)
+      end
+    end
+
+    def angular_add_functions(js, resource)
+      resource.actions.each do |e|
+        method, action = e.values_at :method, :action
+
+        fun_name = Nested::JsUtil::generate_function_name(resource, method, action)
+
+        args = Nested::JsUtil::function_arguments(resource)
+
+        route_args = args.inject({}) do |memo, e|
+          idx = args.index(e)
+          memo[:"#{e}_id"] = "'+(typeof(values[#{idx}]) == 'number' ? values[#{idx}].toString() : values[#{idx}].id)+'"
+          memo
+        end
+        route = "#{self.prefix}" + resource.route(route_args)
+
+        js << "  impl.#{fun_name} = function(#{args.join(',')}){"
+
+        args = args.map{|a| "$q.when(#{a})"}
+
+        js << "    return $q.all([#{args.join(',')}]).then(function(values){" unless args.empty?
+        js << (args.length > 1 ? "  " : "") + "    return $http({method: '#{method}', url: '#{route}'})"
+        js << "    });" unless args.empty?
+
+        js << "  }"
+      end
+
+      resource.resources.each {|r| angular_add_functions(js, r) }
+    end
+
+    def angularize(resource)
+      js = []
+
+      js << "angular.module('Nested-#{resource.name.to_s.gsub(/_/, '-')}', ['ngResource'])"
+      js << ".factory('#{resource.name.to_s.camelcase.capitalize}Service', function($http, $q){"
+
+      js << "  var impl = {}"
+      angular_add_functions(js, resource)
+      js << "  return impl"
+
+      js << "})"
+
+      get "/#{resource.name}.js" do
+        content_type :js
+        js.join("\n")
+      end
+    end
+  end
+
+  module JsUtil
+    def self.generate_function_name(resource, method, action)
+        arr = resource.self_and_parents
+
+        fun_name_arr = arr
+                        .reject{|r| r == arr.last }
+                        .map{|r| r.name || :one}
+                        .reverse
+
+        fun_name_arr << action if action
+        fun_name_arr << method
+
+        fun_name_arr.map(&:to_s).join("_").camelcase(:lower)
+    end
+
+    def self.function_arguments(resource)
+
+      resource
+        .self_and_parents.select{|r| r.member?}
+        .map{|r| r.name || r.parent.name}
+        .map(&:to_s)
+        .map(&:singularize)
+        .reverse
+    end
+  end
+
+  module Sinatra
+    def prefix(prefix=nil)
+      if prefix
+        @prefix = prefix
+      else
+        @prefix
+      end
+    end
+    def singleton(name, &block)
+      create_resource(name, true, false, &block)
+    end
+    def many(name, &block)
+      create_resource(name, false, true, &block)
+    end
+    def one(name, &block)
+      create_resource(name, false, false, &block)
+    end
+    def create_resource(name, singleton, collection, &block)
+      ::Nested::Resource.new(self, name, singleton, collection, nil).tap{|r| r.instance_eval(&block) }
+    end
+  end
+
+end

data/nested.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |s|
+  s.name               = "nested"
+  s.version            = "0.0.1"
+
+  s.authors = ["Jan Zimmek"]
+  s.email = %q{jan.zimmek@web.de}
+
+  s.summary = %q{rest dsl}
+  s.description = %q{rest dsl}
+
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency "activesupport"
+  s.add_runtime_dependency "sinatra"
+end

data/test/nested_test.rb

@@ -0,0 +1,401 @@
+require "test/unit"
+require "mocha/setup"
+require "active_support/all"
+require "nested"
+
+class NestedTest < Test::Unit::TestCase
+
+  def singleton!
+    @r = Nested::Resource.new(@sinatra, :project, true, false, nil)
+  end
+
+  def collection!
+    @r = Nested::Resource.new(@sinatra, :project, false, true, nil)
+  end
+
+  def member!
+    @r = Nested::Resource.new(@sinatra, :project, false, false, nil)
+  end
+
+  def setup
+    @sinatra = mock
+  end
+
+  def test_is_singleton
+    singleton!
+    assert_equal true, @r.singleton?
+
+    collection!
+    assert_equal false, @r.singleton?
+  end
+
+  def test_is_collection
+    collection!
+    assert_equal true, @r.collection?
+
+    singleton!
+    assert_equal false, @r.collection?
+  end
+
+  def test_is_member
+    member!
+    assert_equal true, @r.member?
+
+    singleton!
+    assert_equal false, @r.member?
+
+    collection!
+    assert_equal false, @r.member?
+  end
+
+  def test_fetch
+    singleton!
+
+    fetch = -> { }
+    @r.fetch &fetch
+
+    assert_equal(fetch, @r.instance_variable_get("@__fetch"))
+  end
+
+  def test_fetch_object
+    singleton!
+
+    Nested::Resource::FETCH.expects(:call).with(@r, {})
+    @r.fetch_object({})
+
+    fetch = -> { }
+    @r.fetch &fetch
+
+    fetch.expects(:call).with(@r, {})
+    @r.fetch_object({})
+  end
+
+  def test_route
+    # no parent
+    singleton!
+    assert_equal "/project", @r.route
+
+    collection!
+    assert_equal "/projects", @r.route
+
+    member!
+    assert_equal "/projects/:project_id", @r.route
+    assert_equal "/projects/1", @r.route(project_id: 1)
+
+    # --- singleton
+
+    singleton!
+    @r2 = @r.singleton(:statistic) { }
+    assert_equal "/project/statistic", @r2.route
+
+    singleton!
+    @r2 = @r.many(:statistics) { }
+    assert_equal "/project/statistics", @r2.route
+
+    singleton!
+    @r2 = @r.one(:statistic) { }
+    assert_equal "/project/statistics/:statistic_id", @r2.route
+    assert_equal "/project/statistics/1", @r2.route(statistic_id: 1)
+
+    # --- collection
+
+    collection!
+    @r2 = @r.singleton(:statistic) { }
+    assert_equal "/projects/statistic", @r2.route
+
+    collection!
+    @r2 = @r.one { }
+    assert_equal "/projects/:project_id", @r2.route
+    assert_equal "/projects/1", @r2.route(project_id: 1)
+
+    # --- member
+
+    member!
+    @r2 = @r.singleton(:statistic) { }
+    assert_equal "/projects/:project_id/statistic", @r2.route
+    assert_equal "/projects/1/statistic", @r2.route(project_id: 1)
+
+    member!
+    @r2 = @r.many(:statistic) { }
+    assert_equal "/projects/:project_id/statistics", @r2.route
+    assert_equal "/projects/1/statistics", @r2.route(project_id: 1)
+
+    member!
+    @r2 = @r.one(:statistic) { }
+    assert_equal "/projects/:project_id/statistics/:statistic_id", @r2.route
+    assert_equal "/projects/1/statistics/2", @r2.route(project_id: 1, statistic_id: 2)
+
+  end
+
+
+  def test_singleton
+    singleton!
+    @r.expects(:child_resource).with(:statistic, true, false)
+    @r.singleton(:statistic)
+
+    member!
+    @r.expects(:child_resource).with(:statistic, true, false)
+    @r.singleton(:statistic)
+
+    collection!
+    @r.expects(:child_resource).with(:statistic, true, false)
+    @r.singleton(:statistic)
+  end
+
+  def test_one
+    singleton!
+    @r.expects(:child_resource).with(:statistic, false, false)
+    @r.one(:statistic)
+
+    member!
+    @r.expects(:child_resource).with(:statistic, false, false)
+    @r.one(:statistic)
+
+    collection!
+    @r.expects(:child_resource).with(nil, false, false)
+    @r.one
+
+    collection!
+    assert_raise ::Nested::OneWithNameInManyError do
+      @r.one :statistic
+    end
+  end
+
+  def test_many
+    singleton!
+    @r.expects(:child_resource).with(:statistics, false, true)
+    @r.many(:statistics)
+
+    member!
+    @r.expects(:child_resource).with(:statistics, false, true)
+    @r.many(:statistics)
+
+    collection!
+    assert_raise ::Nested::ManyInManyError do
+      @r.many :statistic
+    end
+  end
+
+  def test_get
+    singleton!
+
+    @r.expects(:create_sinatra_route).with(:get, nil)
+    @r.get
+
+    @r.expects(:create_sinatra_route).with(:get, :action)
+    @r.get :action
+  end
+
+  def test_post
+    singleton!
+
+    @r.expects(:create_sinatra_route).with(:post, nil)
+    @r.post
+
+    @r.expects(:create_sinatra_route).with(:post, :action)
+    @r.post :action
+  end
+
+  def test_put
+    singleton!
+
+    @r.expects(:create_sinatra_route).with(:put, nil)
+    @r.put
+
+    @r.expects(:create_sinatra_route).with(:put, :action)
+    @r.put :action
+  end
+
+  def test_delete
+    singleton!
+
+    @r.expects(:create_sinatra_route).with(:delete, nil)
+    @r.delete
+
+    @r.expects(:create_sinatra_route).with(:delete, :action)
+    @r.delete :action
+  end
+
+  def test_child_resource
+    singleton!
+    r = @r.child_resource(:statistic, false, false) { }
+    assert_equal :statistic, r.name
+    assert_equal false, r.instance_variable_get("@singleton")
+    assert_equal false, r.instance_variable_get("@collection")
+
+    singleton!
+    r = @r.child_resource(:statistic, true, false) { }
+    assert_equal :statistic, r.name
+    assert_equal true, r.instance_variable_get("@singleton")
+    assert_equal false, r.instance_variable_get("@collection")
+
+    singleton!
+    r = @r.child_resource(:statistic, false, true) { }
+    assert_equal :statistic, r.name
+    assert_equal false, r.instance_variable_get("@singleton")
+    assert_equal true, r.instance_variable_get("@collection")
+
+    singleton!
+    assert_raise Nested::SingletonAndCollectionError do
+      @r.child_resource(:statistic, true, true) { }
+    end
+  end
+
+  def test_instance_variable_name
+    singleton!
+    assert_equal :project, @r.instance_variable_name
+
+    member!
+    assert_equal :project, @r.instance_variable_name
+
+    collection!
+    assert_equal :projects, @r.instance_variable_name
+  end
+
+  def test_parents
+    singleton!
+    assert_equal [], @r.parents
+
+    r2 = @r.singleton(:statistic) { }
+    assert_equal [@r], r2.parents
+
+    r3 = r2.singleton(:statistic) { }
+    assert_equal [@r, r2], r3.parents
+  end
+
+  def test_self_and_parents
+    singleton!
+    assert_equal [@r], @r.self_and_parents
+
+    r2 = @r.singleton(:statistic) { }
+    assert_equal [r2, @r], r2.self_and_parents
+
+    r3 = r2.singleton(:statistic) { }
+    assert_equal [r3, r2, @r], r3.self_and_parents
+  end
+
+  def test_create_sinatra_route
+    @sinatra.expects(:prefix).at_least_once.returns(nil)
+
+    singleton!
+
+    @sinatra.expects(:send).with(:get, @r.route)
+    @r.create_sinatra_route(:get, nil) { }
+    assert_equal [{method: :get, actions: nil}], @r.actions
+
+    singleton!
+
+    @sinatra.expects(:send).with(:post, @r.route)
+    @r.create_sinatra_route(:post, nil) { }
+    assert_equal [{method: :post, actions: nil}], @r.actions
+
+    singleton!
+
+    @sinatra.expects(:send).with(:post, @r.route)
+    @r.create_sinatra_route(:post, :action) { }
+    assert_equal [{method: :post, actions: :action}], @r.actions
+  end
+
+  # ----
+
+
+
+
+  def test_function_name
+    singleton!
+    assert_equal "get", Nested::JsUtil::generate_function_name(@r, :get, nil)
+
+    collection!
+    assert_equal "get", Nested::JsUtil::generate_function_name(@r, :get, nil)
+
+    member!
+    assert_equal "get", Nested::JsUtil::generate_function_name(@r, :get, nil)
+
+    singleton!
+    assert_equal "myActionGet", Nested::JsUtil::generate_function_name(@r, :get, :my_action)
+
+    collection!
+    assert_equal "myActionGet", Nested::JsUtil::generate_function_name(@r, :get, :my_action)
+
+    member!
+    assert_equal "myActionGet", Nested::JsUtil::generate_function_name(@r, :get, :my_action)
+
+    singleton!
+
+    @sinatra.expects(:prefix).returns(nil)
+    @sinatra.expects(:get)
+    @r2 = @r.singleton(:statistic) { get }
+
+    assert_equal "statisticGet", Nested::JsUtil::generate_function_name(@r2, :get, nil)
+
+    member!
+
+    @sinatra.expects(:prefix).returns(nil)
+    @sinatra.expects(:get)
+    @r2 = @r.singleton(:statistic) { get }
+
+    assert_equal "statisticGet", Nested::JsUtil::generate_function_name(@r2, :get, nil)
+
+    collection!
+
+    @sinatra.expects(:prefix).returns(nil)
+    @sinatra.expects(:get)
+    @r2 = @r.singleton(:statistic) { get }
+
+    assert_equal "statisticGet", Nested::JsUtil::generate_function_name(@r2, :get, nil)
+  end
+
+  # -----------------
+
+  def test_function_arguments
+    # --- singleton
+    singleton!
+    assert_equal [], Nested::JsUtil.function_arguments(@r)
+
+    singleton!
+    assert_equal [], Nested::JsUtil.function_arguments(@r.singleton(:statistic) {})
+
+    singleton!
+    assert_equal [], Nested::JsUtil.function_arguments(@r.many(:statistics) {})
+
+    singleton!
+    assert_equal ["statistic"], Nested::JsUtil.function_arguments(@r.one(:statistic) {})
+
+    singleton!
+    r2 = @r.one(:statistic) {}
+    r3 = r2.singleton(:test) {}
+    assert_equal ["statistic"], Nested::JsUtil.function_arguments(r3)
+
+    # --- member
+
+    member!
+    assert_equal ["project"], Nested::JsUtil.function_arguments(@r)
+
+    member!
+    assert_equal ["project"], Nested::JsUtil.function_arguments(@r.singleton(:statistic) {})
+
+    member!
+    assert_equal ["project"], Nested::JsUtil.function_arguments(@r.many(:statistics) {})
+
+    member!
+    assert_equal ["project", "statistic"], Nested::JsUtil.function_arguments(@r.one(:statistic) {})
+
+    # --- collection
+
+    collection!
+    assert_equal [], Nested::JsUtil.function_arguments(@r)
+
+    collection!
+    assert_equal [], Nested::JsUtil.function_arguments(@r.singleton(:statistic) {})
+
+    collection!
+    assert_equal ["project"], Nested::JsUtil.function_arguments(@r.one {})
+
+    collection!
+    r2 = @r.one {}
+    r3 = r2.one(:statistic) {}
+
+    assert_equal ["project", "statistic"], Nested::JsUtil.function_arguments(r3)
+  end
+
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: nested
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jan Zimmek
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: rest dsl
+email: jan.zimmek@web.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- lib/nested.rb
+- nested.gemspec
+- test/nested_test.rb
+homepage: 
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+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: 2.0.0.rc.2
+signing_key: 
+specification_version: 4
+summary: rest dsl
+test_files:
+- test/nested_test.rb