praxis 0.21 → 2.0.pre.3

data/lib/praxis/request.rb

@@ -1,6 +1,6 @@
 module Praxis
 
-  class Request
+  class Request < Praxis.request_superclass
     attr_reader :env, :query
     attr_accessor :route_params, :action
 
@@ -162,6 +162,12 @@ module Praxis
       @unmatched_versions ||= Set.new
     end
 
+    # Override the inspect instance method of a request, as, by default, the kernel inspect will go nuts
+    # traversing the action and app_instance and therefore all associated instance variables reachable through that
+    def inspect
+      "'@env' => #{@env.inspect},\n'@headers' => #{@headers.inspect},\n'@params' => #{@params.inspect},\n'@query' => #{@query.inspect}"
+    end
+
   end
 
 end

data/lib/praxis/request_superclassing.rb

@@ -0,0 +1,11 @@
+module Praxis
+  class << self
+
+    attr_writer :request_superclass
+
+    def request_superclass
+      @request_superclass || Object
+    end
+
+  end
+end

data/lib/praxis/resource_definition.rb

@@ -49,7 +49,7 @@ module Praxis
         unless base_attributes.empty?
           params do
             base_attributes.each do |base_name, base_attribute|
-              attribute base_name, base_attribute.type, base_attribute.options
+              attribute base_name, base_attribute.type, **base_attribute.options
             end
           end
         end
@@ -87,9 +87,9 @@ module Praxis
         @display_name = string
       end
 
-      def on_finalize
+      def on_finalize(&block)
         if block_given?
-          @on_finalize << Proc.new
+          @on_finalize << proc(&block)
         end
 
         @on_finalize
@@ -168,7 +168,7 @@ module Praxis
 
               parent_attribute = parent_action.params.attributes[parent_name]
 
-              attribute name, parent_attribute.type, parent_attribute.options
+              attribute name, parent_attribute.type, **parent_attribute.options
             end
           end
         end
@@ -221,7 +221,7 @@ module Praxis
       end
 
       def to_href( params )
-        canonical_path.primary_route.path.expand(params)
+        canonical_path.primary_route.path.expand(params.transform_values(&:to_s))
       end
 
       def parse_href(path)

data/lib/praxis/response.rb

@@ -18,7 +18,7 @@ module Praxis
       klass.status = self.status if self.status
     end
 
-    def initialize(status:self.class.status, headers:{}, body:'', location: nil)
+    def initialize(status:self.class.status, headers:{}, body: nil, location: nil)
       @name    = response_name
       @status  = status
       @headers = headers

data/lib/praxis/route.rb

@@ -24,7 +24,7 @@ module Praxis
       path_params = example_hash.select{|k,v| path_param_keys.include? k }
       # Let's generate the example only using required params, to avoid mixing incompatible parameters
       query_params = example_hash.select{|k,v| required_query_param_keys.include? k }
-      example = { verb: self.verb, url: self.path.expand(path_params), query_params: query_params }
+      example = { verb: self.verb, url: self.path.expand(path_params.transform_values(&:to_s)), query_params: query_params }
 
     end
 

data/lib/praxis/routing_config.rb

@@ -55,7 +55,7 @@ module Praxis
       path = (base + path).gsub('//','/')
       # Reject our own options
       route_name = options.delete(:name);
-      pattern = Mustermann.new(path, {ignore_unknown_options: true}.merge( options ))
+      pattern = Mustermann.new(path, **{ignore_unknown_options: true}.merge( options ))
       route = Route.new(verb, pattern, version, name: route_name, prefixed_path: prefixed_path, **options)
       @routes << route
       route

data/lib/praxis/trait.rb

@@ -76,7 +76,7 @@ module Praxis
             dsl_compiler: ActionDefinition::HeadersDSLCompiler,
             case_insensitive_load: true
           }
-          Attributor::Hash.of(key: String).construct(Proc.new {}, hash_opts)
+          Attributor::Hash.of(key: String).construct(Proc.new {}, **hash_opts)
         else
           Attributor::Hash.construct(Proc.new {})
         end

data/lib/praxis/types/media_type_common.rb

@@ -32,8 +32,8 @@ module Praxis
         #
         # @return [String] the string-representation of this type's identifier
         def identifier(identifier=nil)
-          return @identifier.to_s unless identifier
-          (@identifier = MediaTypeIdentifier.load(identifier)).to_s
+          return @identifier unless identifier
+          @identifier = MediaTypeIdentifier.load(identifier)
         end
       end
 

data/lib/praxis/types/multipart.rb

@@ -12,7 +12,7 @@ module Praxis
       return value if value.kind_of?(self) || value.nil?
 
       unless (value.kind_of?(::String) && ! content_type.nil?)
-        raise Attributor::CoercionError, context: context, from: value.class, to: self.name, value: value
+        raise Attributor::CoercionError.new(context: context, from: value.class, to: self.name, value: value)
       end
 
       headers = {'Content-Type' => content_type}

data/lib/praxis/types/multipart_array.rb

@@ -83,7 +83,7 @@ module Praxis
 
         self.multiple << name if multiple
 
-        compiler = Attributor::DSLCompiler.new(self, opts)
+        compiler = Attributor::DSLCompiler.new(self, **opts)
 
         if filename
           filename_attribute = compiler.define('filename', String, required: true)
@@ -218,7 +218,7 @@ module Praxis
       attr_accessor :preamble
       attr_reader :content_type
 
-      def initialize(content_type: self.class.identifier)
+      def initialize(content_type: self.class.identifier.to_s)
         self.content_type = content_type
       end
 

data/lib/praxis/types/multipart_array/part_definition.rb

@@ -14,7 +14,7 @@ module Praxis
 
         def update_attribute(attribute, options, block)
           attribute.options.merge!(options)
-          attribute.type.attributes(options, &block)
+          attribute.type.attributes(**options, &block)
         end
 
         def create_attribute(type=Attributor::Struct, **opts, &block)

data/lib/praxis/version.rb

@@ -1,3 +1,3 @@
 module Praxis
-  VERSION = '0.21'
+  VERSION = '2.0.pre.3'
 end

data/praxis.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
 
   spec.email = ["blanquer@gmail.com","dane.jensen@gmail.com"]
 
-  spec.homepage = "https://github.com/rightscale/praxis"
+  spec.homepage = "https://github.com/praxis/praxis"
   spec.license = "MIT"
   spec.required_ruby_version = ">=2.1"
 
@@ -20,24 +20,22 @@ Gem::Specification.new do |spec|
   spec.bindir = 'bin'
   spec.executables << 'praxis'
 
-  spec.add_dependency 'rack', '~> 1'
-  spec.add_dependency 'mustermann', '~> 0'
+  spec.add_dependency 'rack', '>= 1'
+  spec.add_dependency 'mustermann', '>=1.1', '<=2'
   spec.add_dependency 'activesupport', '>= 3'
   spec.add_dependency 'mime', '~> 0'
-  spec.add_dependency 'praxis-mapper', '~> 4.3'
-  spec.add_dependency 'praxis-blueprints', '~> 3.3'
-  spec.add_dependency 'attributor', '~> 5.1'
-  spec.add_dependency 'thor', '~> 0.18'
+  spec.add_dependency 'praxis-blueprints', '>= 3.4'
+  spec.add_dependency 'attributor', '>= 5.4'
+  spec.add_dependency 'thor'
   spec.add_dependency 'terminal-table', '~> 1.4'
-  spec.add_dependency 'harness', '~> 2'
 
-  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake', '~> 0.9'
   spec.add_development_dependency 'rake-notes', '~> 0'
   if RUBY_PLATFORM !~ /java/
-    spec.add_development_dependency 'pry', '~> 0'
-    spec.add_development_dependency 'pry-byebug', '~> 1'
-    spec.add_development_dependency 'pry-stack_explorer', '~> 0'
+    spec.add_development_dependency 'pry'
+    spec.add_development_dependency 'pry-byebug'
+    spec.add_development_dependency 'pry-stack_explorer'
     spec.add_development_dependency 'sqlite3', '~> 1'
   else
     spec.add_development_dependency 'jdbc-sqlite3'
@@ -51,6 +49,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rack-test', '~> 0'
   spec.add_development_dependency 'simplecov', '~> 0'
   spec.add_development_dependency 'fuubar', '~> 2'
-  spec.add_development_dependency 'yard', '~> 0'
+  spec.add_development_dependency 'yard', ">= 0.9.20"
   spec.add_development_dependency 'coveralls'
+  # Just for the query selector extensions etc...
+  spec.add_development_dependency 'sequel', '~> 5'
+  spec.add_development_dependency 'activerecord', '> 4'
 end

data/spec/functional_spec.rb

@@ -136,7 +136,6 @@ describe 'Functional specs' do
     headers = last_response.headers
     expect(headers['Content-Type']).to eq('application/json')
     expect(headers['Spec-Middleware']).to eq('used')
-    expect(headers['Content-Length']).to eq(last_response.body.size.to_s)
   end
 
   it 'returns early when making the before filter break' do
@@ -333,11 +332,11 @@ describe 'Functional specs' do
 
   context 'wildcard verb routing' do
     it 'can terminate instances with POST' do
-      post '/api/clouds/23/instances/1/terminate?api_version=1.0', nil, 'global_session' => session
+      post '/api/clouds/23/instances/1/terminate?api_version=1.0', '', 'global_session' => session
       expect(last_response.status).to eq(200)
     end
     it 'can terminate instances with DELETE' do
-      post '/api/clouds/23/instances/1/terminate?api_version=1.0', nil, 'global_session' => session
+      post '/api/clouds/23/instances/1/terminate?api_version=1.0', '', 'global_session' => session
       expect(last_response.status).to eq(200)
     end
 
@@ -352,18 +351,16 @@ describe 'Functional specs' do
       get '/api/clouds/23/otherinstances/_action/exceptional?api_version=1.0', nil, 'global_session' => session
       expect(last_response.status).to eq(404)
     end
-
-
   end
 
   context 'auth_plugin' do
     it 'can terminate' do
-      post '/api/clouds/23/instances/1/terminate?api_version=1.0', nil, 'global_session' => session
+      post '/api/clouds/23/instances/1/terminate?api_version=1.0', '', 'global_session' => session
       expect(last_response.status).to eq(200)
     end
 
     it 'can not stop' do
-      post '/api/clouds/23/instances/1/stop?api_version=1.0', nil, 'global_session' => session
+      post '/api/clouds/23/instances/1/stop?api_version=1.0', '', 'global_session' => session
       expect(last_response.status).to eq(403)
     end
   end

data/spec/praxis/action_definition_spec.rb

@@ -281,7 +281,7 @@ describe Praxis::ActionDefinition do
     subject(:action) { resource_definition.actions[:show] }
 
     it 'works' do
-      expansion = action.primary_route.path.expand(cloud_id:232, id: 2)
+      expansion = action.primary_route.path.expand(cloud_id:'232', id: '2')
       expect(expansion).to eq "/api/clouds/232/instances/2"
     end
 

data/spec/praxis/application_spec.rb

@@ -27,7 +27,7 @@ describe Praxis::Application do
       end
 
       it 'passes the params and block to config' do
-        ret = app.config(:key, Attributor::Hash, {option: :one}, &myblock)
+        ret = app.config(:key, Attributor::Hash, **{option: :one}, &myblock)
         expect(ret).to eq([:key, Attributor::Hash, {option: :one}, myblock])
       end
 

data/spec/praxis/collection_spec.rb

@@ -8,6 +8,7 @@ describe Praxis::Collection do
   subject!(:collection) do
     Praxis::Collection.of(member_type)
   end
+  let(:identifier_string) { subject.identifier.to_s }
 
   context '.of' do
     let(:member_type) do
@@ -16,7 +17,7 @@ describe Praxis::Collection do
       end
     end
 
-    its(:identifier) { should eq 'application/an-awesome-type; type=collection' }
+    it { expect(identifier_string).to eq('application/an-awesome-type; type=collection') }
 
     it 'sets the collection on the media type' do
       expect(member_type::Collection).to be(collection)
@@ -34,7 +35,7 @@ describe Praxis::Collection do
   context 'defined explicitly' do
     subject(:type) { Volume::Collection }
     its(:member_type) { should be Volume }
-    its(:identifier) { should eq 'application/vnd.acme.volumes' }
+    it { expect(identifier_string).to eq('application/vnd.acme.volumes') }
   end
 
   context '.member_type' do

data/spec/praxis/config_spec.rb

@@ -72,12 +72,12 @@ describe Praxis::Config do
       
       it 'it is not allowed if its for the top key' do
         expect{
-          config.define nil, config_type, config_opts
+          config.define nil, config_type, **config_opts
         }.to raise_error(/You cannot define the top level configuration with a non-Struct type/)
       end
       
       before do
-        config.define config_key, config_type, config_opts
+        config.define config_key, config_type, **config_opts
       end
 
       it 'sets the attribute to the defined type' do

data/spec/praxis/extensions/field_selection/active_record_query_selector_spec.rb

@@ -0,0 +1,106 @@
+require 'spec_helper'
+
+require_relative 'support/spec_resources_active_model.rb'
+
+describe Praxis::Extensions::FieldSelection::ActiveRecordQuerySelector do
+  let(:selector_fields) do
+    { 
+      name: true,
+      author: {
+        id: true,
+        books: true
+      },
+      category: {
+        name: true,
+        books: true
+      },
+      tags: {
+        name: true
+      }
+    }
+  end
+  let(:expected_select_from_to_query) do
+    # The columns to select from the top Simple model
+    [
+      :simple_name, # from the :name alias
+      :author_id, # the FK needed for the author association
+      :added_column, # from the extra column defined in the parent property
+      :category_uuid, # the FK needed for the cateory association
+      :id # We always load the primary keys
+    ]
+  end
+  let(:selector_node) { Praxis::Mapper::SelectorGenerator.new.add(ActiveBookResource,selector_fields)  }
+
+  subject(:selector) {described_class.new(query: query, selectors: selector_node) }
+  context '#generate with a mocked' do
+    let(:query) { double("Query") }
+    it 'calls the select columns for the top level, and includes the right association hashes' do      
+      expect(query).to receive(:select).with(*expected_select_from_to_query).and_return(query)
+      expected_includes = {
+        author: {
+          books: {}
+        },
+        category: {
+          books: {}
+        },
+        tags: {}
+      }
+      expect(query).to receive(:includes).with(expected_includes).and_return(query)
+      expect(subject).to_not receive(:explain_query)
+      subject.generate
+    end 
+    it 'calls the explain debug method if enabled' do
+      expect(query).to receive(:select).and_return(query)
+      expect(query).to receive(:includes).and_return(query)
+      expect(subject).to receive(:explain_query)
+      subject.generate(debug: true)      
+    end 
+  end
+
+  context '#generate with a real AR model' do
+    let(:query) { ActiveBook }
+
+    it 'calls the select columns for the top level, and includes the right association hashes' do
+      expected_includes = {
+        author: {
+          books: {}
+        },
+        category: {
+          books: {}
+        },
+        tags: {}
+      }
+      #expect(query).to receive(:includes).with(expected_includes).and_return(query)
+      expect(subject).to_not receive(:explain_query)
+      final_query = subject.generate
+      expect(final_query.select_values).to match_array(expected_select_from_to_query)
+      # Our query selector always uses a single hash tree from the top, not an array of things
+      includes_hash = final_query.includes_values.first
+      expect(includes_hash).to match(expected_includes)
+      # Also, make AR do the actual query to make sure everything is wired up correctly
+      result = final_query.to_a
+      expect(result.size).to be 2
+      book1 = result[0]
+      book2 = result[1]
+      expect(book1.author.id).to eq 11
+      expect(book1.author.books.size).to eq 1
+      expect(book1.author.books.map(&:simple_name)).to eq(['Book1'])
+      expect(book1.category.name).to eq 'cat1'
+      expect(book1.tags.map(&:name)).to match_array(['blue','red'])
+
+      expect(book2.author.id).to eq 22
+      expect(book2.author.books.size).to eq 1
+      expect(book2.author.books.map(&:simple_name)).to eq(['Book2'])
+      expect(book2.category.name).to eq 'cat2'
+      expect(book2.tags.map(&:name)).to match_array(['red'])
+    end
+
+    it 'calls the explain debug method if enabled' do
+      suppress_output do
+        # Actually make it run all the way...but suppressing the output
+        subject.generate(debug: true)
+      end
+    end 
+  end
+
+end

data/spec/praxis/extensions/field_selection/sequel_query_selector_spec.rb

@@ -0,0 +1,147 @@
+require 'spec_helper'
+require 'sequel'
+
+require 'praxis/extensions/field_selection/sequel_query_selector'
+
+
+describe Praxis::Extensions::FieldSelection::SequelQuerySelector do
+  class Q
+    attr_reader :object, :cols
+    def initialize
+      @object = {}
+      @cols = []
+    end
+    def eager(hash)
+      raise "we are only calling eager one at a time!" if hash.keys.size > 1
+      name = hash.keys.first
+      # Actually call the incoming proc with an instance of Q, to collect the further select/eager calls
+      @object[name] = hash[name].call(Q.new)
+      self
+    end
+    def select(*names)
+      @cols += names.map(&:column)
+      self
+    end
+    def dump
+      eagers = @object.each_with_object({}) do |(name, val), hash|
+        hash[name] = val.dump
+      end
+      {
+        columns: @cols,
+        eagers: eagers
+      }
+    end
+  end
+
+
+  # Pay the price for creating and connecting only in this spec instead in spec helper
+  # this way all other specs do not need to be slower and it's a better TDD experience
+
+  require_relative 'support/spec_resources_sequel.rb'
+  
+  let(:selector_fields) do
+    { 
+      name: true,
+      other_model: {
+        id: true
+      },
+      parent: {
+        children: true
+      },
+      tags: {
+        tag_name: true
+      }
+    }
+  end
+  let(:expected_select_from_to_query) do
+    # The columns to select from the top Simple model
+    [
+      :simple_name, # from the :name alias
+      :added_column, # from the extra column defined in the parent property
+      :id, # We always load the primary keys
+      :other_model_id, # the FK needed for the other_model association
+      :parent_id # the FK needed for the parent association
+    ]
+  end
+
+  let(:selector_node) { Praxis::Mapper::SelectorGenerator.new.add(SequelSimpleResource,selector_fields)  }
+  subject {described_class.new(query: query, selectors: selector_node) }
+
+  context 'generate' do
+    context 'using the real models and DB' do
+      let(:query) { SequelSimpleModel }
+
+      it 'calls the select columns for the top level, and includes the right association hashes' do      
+        ds = subject.generate
+        opts = ds.opts
+        # Top model is our simplemodel
+        expect(opts[:model]).to be(SequelSimpleModel)
+        selected_column_names = opts[:select].map(&:column)
+        expect(selected_column_names).to match_array(expected_select_from_to_query)
+        # 2 Eager loaded associations as well
+        expect(opts[:eager].keys).to match_array([:other_model, :parent, :tags])
+        # We can not introspect those eagers, as they are procs...but at least validate they are
+        expect(opts[:eager][:other_model]).to be_a Proc
+        expect(opts[:eager][:parent]).to be_a Proc
+        
+        # Also, let's make sure the query actually works by making Sequel attempt to retrieve it and finding the right things.
+        result = ds.all
+        # 2 simple models
+        expect(result.size).to be 2 
+        # First simple model points to other_model 11 and parent 1
+        simple_one = result.find{|i| i.id == 1}
+        expect(simple_one.other_model.id).to be 11
+        expect(simple_one.parent.id).to be 1
+        # also, its' parent in turn has 2 children (1 and 2) linked by its parent_uuid
+        expect(simple_one.parent.children.map(&:id)).to match_array([1,2])
+        # Has the blue and red tags
+        expect(simple_one.tags.map(&:tag_name)).to match_array(['blue','red'])
+
+        # second simple model points to other_model 22 and parent 2
+        simple_two = result.find{|i| i.id == 2}
+        expect(simple_two.other_model.id).to be 22
+        expect(simple_two.parent.id).to be 2
+        # also, its' parent in turn has no children (as no simple models point to it by uuid)
+        expect(simple_two.parent.children.map(&:id)).to be_empty
+        # Also has the red tag
+        expect(simple_two.tags.map(&:tag_name)).to match_array(['red'])
+      end
+      it 'calls the explain debug method if enabled' do
+        suppress_output do
+          # Actually make it run all the way...but suppressing the output
+          subject.generate(debug: true)
+        end
+      end 
+    end
+    context 'just mocking the query' do
+      let(:query) { Q.new }
+
+      it 'creates the right recursive lambdas for the eager loading' do      
+        
+        ds = subject.generate
+        result = ds.dump
+        expect(result[:columns]).to match_array(expected_select_from_to_query)
+        # 2 eager loads
+        expect(result[:eagers].keys).to match_array([:other_model, :parent, :tags])
+        # 1 - other model
+        other_model_eagers = result[:eagers][:other_model]
+        expect(other_model_eagers[:columns]).to match_array([:id])
+
+        # 2 - parent association
+        parent_eagers = result[:eagers][:parent]
+        expect(parent_eagers[:columns]).to match_array([:id,:uuid]) # uuid is necessary for the "children" assoc
+        expect(parent_eagers[:eagers].keys).to match_array([:children])
+        # 2.1 - children association off of the parent
+        parent_children_eagers = parent_eagers[:eagers][:children]
+        expect(parent_children_eagers[:columns]).to match_array([:id,:parent_uuid]) # parent_uuid is required for the assoc
+        expect(parent_children_eagers[:eagers]).to be_empty
+
+        # 3 - tags association
+        tags_eagers = result[:eagers][:tags]
+        expect(tags_eagers[:columns]).to match_array([:id, :tag_name]) # uuid is necessary for the "children" assoc
+        expect(tags_eagers[:eagers].keys).to be_empty
+        
+      end
+    end
+  end
+end