praxis 0.22.pre.2 → 2.0.pre.5

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.22.pre.2'
+  VERSION = '2.0.pre.5'
 end

data/praxis.gemspec

@@ -21,22 +21,21 @@ Gem::Specification.new do |spec|
   spec.executables << 'praxis'
 
   spec.add_dependency 'rack', '>= 1'
-  spec.add_dependency 'mustermann', '>=0', '<=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.5'
+  spec.add_dependency 'attributor', '>= 5.5'
+  spec.add_dependency 'thor'
   spec.add_dependency 'terminal-table', '~> 1.4'
 
   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'
@@ -50,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

data/spec/praxis/action_definition_spec.rb

@@ -1,15 +1,6 @@
 require 'spec_helper'
 
 describe Praxis::ActionDefinition do
-  
-  before(:context) do
-    Thread.current[:praxis_instance] = Praxis::Application.new(name: 'action_definition_spec', skip_registration: true)
-  end
-  
-  let(:praxis_instance) do
-    Thread.current[:praxis_instance]
-  end
-  
   class SpecMediaType < Praxis::MediaType
     identifier 'application/json'
 
@@ -40,8 +31,10 @@ describe Praxis::ActionDefinition do
       end
     end
   end
+
   subject(:action) do
-    praxis_instance.api_definition.define do |api|
+
+    Praxis::ApiDefinition.define do |api|
       api.response_template :ok do |media_type: , location: nil, headers: nil, description: nil |
         status 200
 
@@ -49,10 +42,6 @@ describe Praxis::ActionDefinition do
         location location
         headers headers if headers
       end
-      
-      api.info do # applies to all API infos
-        base_path "/pref"
-      end
     end
     Praxis::ActionDefinition.new(:foo, resource_definition) do
       routing { get '/:one' }
@@ -122,11 +111,11 @@ describe Praxis::ActionDefinition do
     let(:traits) { {test: trait} }
 
     before do
-      allow(praxis_instance.api_definition).to receive(:traits).and_return(traits)
+      allow(Praxis::ApiDefinition.instance).to receive(:traits).and_return(traits)
     end
 
     its('params.attributes.keys') { should eq [:inherited, :app_name, :name, :one]}
-    its('routes.first.path.to_s') { should eq '/pref/foobars/hello_world/test_trait/:app_name/:one' }
+    its('routes.first.path.to_s') { should eq '/api/foobars/hello_world/test_trait/:app_name/:one' }
     its(:traits) { should eq [:test] }
 
     it 'is reflected in the describe output' do
@@ -292,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
 
@@ -326,9 +315,11 @@ describe Praxis::ActionDefinition do
   end
 
   context 'with a base_path and base_params on ApiDefinition' do
-    subject(:action) do
-      api_def=Praxis::ApiDefinition.new(praxis_instance)
-      api_def.define do |api|
+    # Without getting a fresh new ApiDefinition it is very difficult to test stuff using the Singleton
+    # So for some tests we're gonna create a new instance and work with it to avoid the singleton issues
+    let(:non_singleton_api) do
+      api_def=Praxis::ApiDefinition.__send__(:new)
+      api_def.instance_eval do |api|
 
         api.info do
           base_path '/apps/:app_name'
@@ -341,13 +332,11 @@ describe Praxis::ActionDefinition do
         end
 
       end
-      # No setter...and its fine to do it here as it would not be used in a runtime situation
-      praxis_instance.instance_variable_set(:@api_definition, api_def)
-      # Define the action after the api_definition is set (as it uses is config to setup the routes)
-      Praxis::ActionDefinition.new(:bar, resource_definition) do
-        routing { get '/:one' }
-        params  { attribute :one, String }
-      end
+      api_def
+    end
+
+    before do
+      allow(Praxis::ApiDefinition).to receive(:instance).and_return(non_singleton_api)
     end
 
     its('routes.first.path.to_s') { should eq '/apps/:app_name/foobars/hello_world/:one' }

data/spec/praxis/api_definition_spec.rb

@@ -2,18 +2,12 @@ require 'spec_helper'
 
 describe Praxis::ApiDefinition do
 
-  # TODO: perhaps grab the spec app instance from some global var...(instead of relying on the singleton compat method)
-  subject(:api){ Praxis::ApiDefinition.instance } 
+  subject(:api){  Praxis::ApiDefinition.instance }
 
   # Without getting a fresh new ApiDefinition it is very difficult to test stuff using the Singleton
   # So for some tests we're gonna create a new instance and work with it to avoid the singleton issues
-  let(:app_instance){ double("AppInstance") }
-  before do
-    allow(app_instance).to receive(:versioning_scheme=).with([:header, :params])
-  end
-  
   let(:non_singleton_api) do
-    api_def=Praxis::ApiDefinition.new(app_instance)
+    api_def=Praxis::ApiDefinition.__send__(:new)
     api_def.instance_eval do |api|
       api.response_template :template1, &Proc.new {}
       api.trait :trait1, &Proc.new {}
@@ -38,7 +32,12 @@ describe Praxis::ApiDefinition do
     end
   end
 
-  context 'initial definition' do
+  context 'singleton' do
+    it 'should be a Singleton' do
+      expect(Praxis::ApiDefinition.ancestors).to include( Singleton )
+      expect(subject).to eq(Praxis::ApiDefinition.instance )
+    end
+
     it 'has the :ok and :created response templates registered' do
       expect(api.responses.keys).to include(:ok)
       expect(api.responses.keys).to include(:created)
@@ -59,10 +58,6 @@ describe Praxis::ApiDefinition do
       expect(api.responses.keys).to include(:foobar)
       expect(api.response(:foobar)).to be_kind_of(Praxis::ResponseTemplate)
     end
-    it 'stores the app instance' do
-      template = api.response(:template1)
-      expect(template.application).to be(app_instance)
-    end
   end
 
   context '.response' do

data/spec/praxis/api_general_info_spec.rb

@@ -2,7 +2,12 @@ require 'spec_helper'
 
 describe Praxis::ApiGeneralInfo do
 
-  subject(:info){ Praxis::ApiGeneralInfo.new(application: APP) }
+  subject(:info){ Praxis::ApiGeneralInfo.new }
+
+  before do
+    allow(Praxis::Application.instance).to receive(:versioning_scheme=).with([:header, :params])
+  end
+
 
   let(:info_block) do
     Proc.new do
@@ -59,8 +64,8 @@ describe Praxis::ApiGeneralInfo do
   end
 
   context 'base_path with versioning' do
-    let(:global_info){ Praxis::ApiGeneralInfo.new(application: APP) }
-    subject(:info){ Praxis::ApiGeneralInfo.new(global_info, application: APP, version: '1.0') }
+    let(:global_info){ Praxis::ApiGeneralInfo.new }
+    subject(:info){ Praxis::ApiGeneralInfo.new(global_info, version: '1.0') }
 
     before do
       global_info

data/spec/praxis/application_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe Praxis::Application do
   context 'configuration' do
     subject(:app) do
-      app = Class.new(Praxis::Application).new(skip_registration: true)
+      app = Class.new(Praxis::Application).instance
 
       config = Object.new
       def config.define(key=nil, type=Attributor::Struct, **opts, &block)
@@ -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
 
@@ -45,7 +45,7 @@ describe Praxis::Application do
   end
 
   context 'media type handlers' do
-    subject { Class.new(Praxis::Application).new(skip_registration: true) }
+    subject { Class.new(Praxis::Application).instance }
 
     before do
       # don't actually bootload; we're merely running specs
@@ -94,14 +94,12 @@ describe Praxis::Application do
   end
 
   describe '#setup' do
-    subject { Praxis::Application.new(skip_registration: true) }
-    let(:boot_loader) { double("BL", setup!: true) }
-    let(:builder) { double("Builder", to_app: double('Rack app'), run: true) }
-    
+    subject { Class.new(Praxis::Application).instance }
+
     before do
-      # don't actually bootload; we're merely running specs  
-      allow(subject).to receive(:bootloader).and_return(boot_loader)
-      allow(subject).to receive(:builder).and_return(builder)
+      # don't actually bootload; we're merely running specs
+      allow(subject.bootloader).to receive(:setup!).and_return(true)
+      allow(subject.builder).to receive(:to_app).and_return(double('Rack app'))
     end
 
     it 'is idempotent' do
@@ -114,9 +112,5 @@ describe Praxis::Application do
       expect(subject.setup).to eq(subject)
       expect(subject.setup).to eq(subject)
     end
-    
-    it 'creates an ApiDefinition that has a back-reference' do
-      expect(subject.api_definition.application).to eq(subject)
-    end
   end
 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