praxis 0.18.1 → 0.19.0

data/lib/praxis/plugins/praxis_mapper_plugin.rb

@@ -36,7 +36,7 @@ require 'terminal-table'
 #      output into the Praxis::Application.instance.logger app log. Possible
 #      values are: "detailed", "short", and "skip" (i.e. do not print the stats
 #      at all).
-#   3. stats_log_level: the logging level with which the statistics should be logged. 
+#   3. stats_log_level: the logging level with which the statistics should be logged.
 #
 # See http://praxis-framework.io/reference/plugins/ for further details on how
 # to use a plugin and pass it options.
@@ -76,7 +76,7 @@ module Praxis
         def prepare_config!(node)
           node.attributes do
             attribute :log_stats, String, values: ['detailed', 'short', 'skip'], default: 'detailed'
-            attribute :stats_log_level, Symbol, values: [:fatal,:error,:warn,:info,:debug], default: :info            
+            attribute :stats_log_level, Symbol, values: [:fatal,:error,:warn,:info,:debug], default: :info
             attribute :repositories, Attributor::Hash.of(key: String, value: RepositoryConfig)
           end
         end
@@ -104,7 +104,8 @@ module Praxis
           log_stats = PraxisMapperPlugin::Plugin.instance.config.log_stats
           unless log_stats == 'skip'
             Praxis::Notifications.subscribe 'praxis.request.all' do |name, *junk, payload|
-              if (identity_map = payload[:request].identity_map)
+              if (payload[:request].identity_map?)
+                identity_map = payload[:request].identity_map
                 PraxisMapperPlugin::Statistics.log(payload[:request], identity_map, log_stats)
               end
             end
@@ -122,13 +123,17 @@ module Praxis
 
       module Request
         def identity_map
-          @identity_map
+          @identity_map ||= Praxis::Mapper::IdentityMap.new
         end
 
         def identity_map=(map)
           @identity_map = map
         end
-        
+
+        def identity_map?
+          !@identity_map.nil?
+        end
+
         def silence_mapper_stats
           @silence_mapper_stats
         end
@@ -143,10 +148,24 @@ module Praxis
         extend ActiveSupport::Concern
 
         included do
-          before :action do |controller|
-            controller.request.identity_map = Praxis::Mapper::IdentityMap.new
+          # Ensure we call #release on any identity map
+          # that may be set by the controller after the action
+          # completes.
+          around :action do |controller, callee|
+            begin
+              callee.call
+            ensure
+              if controller.request.identity_map?
+                controller.request.identity_map.release
+              end
+            end
           end
         end
+
+        def identity_map
+          request.identity_map
+        end
+
       end
 
       module Statistics
@@ -158,8 +177,8 @@ module Praxis
             self.to_logger "No database interactions observed."
             return
           end
-          
-          
+
+
           case log_stats
           when 'detailed'
             self.detailed(identity_map)
@@ -217,7 +236,7 @@ module Praxis
         def self.short(identity_map)
           self.to_logger identity_map.query_statistics.sum_totals.to_s
         end
-        
+
         def self.to_logger(message)
             Praxis::Application.instance.logger.__send__(Plugin.instance.config.stats_log_level, "Praxis::Mapper Statistics: #{message}")
         end

data/lib/praxis/restful_doc_generator.rb

@@ -17,7 +17,8 @@ module Praxis
       Attributor::Ids,
       Attributor::Integer,
       Attributor::Object,
-      Attributor::String
+      Attributor::String,
+      Attributor::Symbol
     ]).freeze
 
     def self.inspect_attributes(the_type)
@@ -33,7 +34,7 @@ module Praxis
         if the_type.member_attribute.nil?
           the_type = the_type.member_type
         else
-          the_type = the_type.member_attribute.type 
+          the_type = the_type.member_attribute.type
         end
       end
 
@@ -74,9 +75,6 @@ module Praxis
         # Collect reachable types from the media_type if any (plus itself)
         if @media_type && ! @media_type.is_a?(Praxis::SimpleMediaType)
           add_to_reachable RestfulDocGenerator.inspect_attributes(@media_type)
-          @media_type.attributes.each do |name, attr|
-            add_to_reachable RestfulDocGenerator.inspect_attributes(attr)
-          end
           @generated_example = @media_type.example(self.id)
         end
 
@@ -133,6 +131,10 @@ module Praxis
         return if found == nil
         @reachable_types += found
       end
+
+      def display_name
+        @controller_config.display_name
+      end
     end
 
     def initialize(root_dir)
@@ -141,7 +143,7 @@ module Praxis
       @resources = []
 
       Attributor::AttributeResolver.current = Attributor::AttributeResolver.new
-      
+
       remove_previous_doc_data
       load_resources
 
@@ -276,7 +278,7 @@ module Praxis
           info[:media_type] = r.media_type.id
           media_types_seen_from_controllers << r.media_type
         end
-        display_name  = r.name.split("::").last
+        display_name  = r.display_name #.name.split("::").last
         index[r.version][display_name] = info
       end
 
@@ -288,7 +290,8 @@ module Praxis
 
         reportable_types.each do |type|
           index[version] ||= Hash.new
-          display_name = type.name.split("::").last
+          next unless type.respond_to?(:display_name)
+          display_name = type.display_name #.name.split("::").last
           if index[version].has_key? display_name
             raise "Display name already taken for version #{version}! #{display_name}"
           end

data/lib/praxis/tasks/api_docs.rb

@@ -37,16 +37,17 @@ namespace :praxis do
       exec({'USER_DOCS_PATH' => File.join(Dir.pwd, 'docs')}, "#{path}/node_modules/.bin/grunt build --gruntfile '#{path}/Gruntfile.js'")
     end
 
-    desc "Generate API docs (JSON definitions) for a Praxis App"
-    task :generate => [:environment] do |t, args|
+    desc "Generate deprecated API docs (JSON definitions) for a Praxis App"
+    task :generate_old => [:environment] do |t, args|
       require 'fileutils'
+      STDERR.puts "DEPRECATION: praxis:docs:generate_old is deprecated and will be removed in the next version. Please update tooling that may need this."
 
       Praxis::Blueprint.caching_enabled = false
       generator = Praxis::RestfulDocGenerator.new(Dir.pwd)
     end
 
-    desc "Generate BETA API docs (JSON definitions) for a Praxis App"
-    task :generate_beta => [:environment] do |t, args|
+    desc "Generate API docs (JSON definitions) for a Praxis App"
+    task :generate => [:environment] do |t, args|
       require 'fileutils'
 
       Praxis::Blueprint.caching_enabled = false
@@ -59,7 +60,7 @@ namespace :praxis do
   desc "Generate API docs (JSON definitions) for a Praxis App"
   task :api_docs do
     STDERR.puts "DEPRECATION: praxis:api_docs is deprecated and will be removed by 1.0. Please use praxis:docs:generate instead."
-    Rake::Task["praxis:docs:generate"].invoke
+    Rake::Task["praxis:docs:generate_old"].invoke
   end
 
   desc "Run API Documentation Browser"

data/lib/praxis/types/multipart_array.rb

@@ -110,7 +110,7 @@ module Praxis
       end
 
       def self.file(name, payload_type=nil, filename: nil, **opts, &block)
-        self.part(name, payload_type=nil, filename: true, **opts, &block)
+        self.part(name, payload_type, filename: true, **opts, &block)
       end
 
       def self.load(value, context=Attributor::DEFAULT_ROOT_CONTEXT, content_type:nil)

data/lib/praxis/version.rb

@@ -1,3 +1,3 @@
 module Praxis
-  VERSION = '0.18.1'
+  VERSION = '0.19.0'
 end

data/lib/praxis.rb

@@ -83,6 +83,11 @@ module Praxis
     autoload :Validation, 'praxis/exceptions/validation'
   end
 
+  module Extensions
+    autoload :MapperSelectors, 'praxis/extensions/mapper_selectors'
+    autoload :Rendering, 'praxis/extensions/rendering'
+    autoload :FieldExpansion, 'praxis/extensions/field_expansion'
+  end
 
   module Handlers
     autoload :Plain, 'praxis/handlers/plain'

data/praxis.gemspec

@@ -24,9 +24,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'mustermann', '~> 0'
   spec.add_dependency 'activesupport', '>= 3'
   spec.add_dependency 'mime', '~> 0'
-  spec.add_dependency 'praxis-mapper', '>= 4.1'
-  spec.add_dependency 'praxis-blueprints', '>= 2.2'
-  spec.add_dependency 'attributor', '>= 4.0.1'
+  spec.add_dependency 'praxis-mapper', '~> 4.2'
+  spec.add_dependency 'praxis-blueprints', '~> 3.1'
+  spec.add_dependency 'attributor', '~> 5.0'
   spec.add_dependency 'thor', '~> 0.18'
   spec.add_dependency 'terminal-table', '~> 1.4'
   spec.add_dependency 'harness', '~> 2'
@@ -48,4 +48,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'fuubar', '~> 2'
   spec.add_development_dependency 'yard', '~> 0'
   spec.add_development_dependency 'sqlite3', '~> 1'
+  spec.add_development_dependency 'coveralls'
 end

data/spec/api_browser/factories/configuration_spec.js

@@ -0,0 +1,32 @@
+describe('Configuration', function() {
+  var theConfigProvider, runFn;
+  beforeEach(function() {
+    angular.module('PraxisDocBrowser').config(function(ConfigurationProvider) {
+      theConfigProvider = ConfigurationProvider;
+    });
+    runFn = angular.module('PraxisDocBrowser')._runBlocks[0];
+  });
+
+  beforeEach(angular.mock.module('PraxisDocBrowser'));
+
+  beforeEach(inject(function(Configuration) {
+    Configuration;
+  }));
+
+  it('sets sensible defaults', function() {
+    expect(theConfigProvider).toEqual(jasmine.objectContaining({
+      title: 'API Browser',
+      versionLabel: 'API Version',
+      expandChildren: true
+    }));
+  });
+
+  it('assigns all things from the provider unto the root scope', inject(function($injector, $rootScope) {
+    $injector.invoke(runFn);
+    expect($rootScope).toEqual(jasmine.objectContaining({
+      title: 'API Browser',
+      versionLabel: 'API Version',
+      expandChildren: true
+    }));
+  }));
+});

data/spec/api_browser/factories/documentation_spec.js

@@ -4,9 +4,33 @@ describe('Documentation service', function() {
   beforeEach(angular.mock.module('PraxisDocBrowser'));
 
   beforeEach(inject(function($rootScope, $injector) {
+    $httpBackend = $injector.get('$httpBackend');
+    $httpBackend.expectGET('api/index-new.json').respond({
+      versions: ['1.0', '2.0']
+    });
+    $httpBackend.expectGET('api/1.0.json').respond({
+      resources: {
+        foo: {
+
+        }
+      },
+      schemas: {
+        bar: {
+
+        }
+      }
+    });
+    $httpBackend.expectGET('api/2.0.json').respond({
+      resources: {
+        test: 'TestCTRL'
+      },
+      schemas: {
+        testType: 'TestType'
+      }
+    });
     $scope = $rootScope.$new();
     Documentation = $injector.get('Documentation');
-    $httpBackend = $injector.get('$httpBackend');
+    $httpBackend.flush();
   }));
 
   afterEach(function() {
@@ -14,37 +38,63 @@ describe('Documentation service', function() {
     $httpBackend.verifyNoOutstandingRequest();
   });
 
-  describe('#getIndex', function() {
-    var result, response = {
-      '1.0': {
-        'Blogs': {
-          'controller': 'V1-Controllers-Blogs',
-          'name': 'V1::Controllers::Blogs',
-          'media_type': 'V1-MediaTypes-Blog'
-        },
-        'Posts': {
-          'controller': 'V1-ResourceDefinitions-Posts',
-          'name': 'V1::ResourceDefinitions::Posts',
-          'media_type': 'V1-MediaTypes-Post'
+  describe('#versions', function() {
+    var versions;
+    beforeEach(function() {
+      Documentation.versions().then(function(v) {
+        versions = v;
+      });
+      $scope.$apply();
+    });
+    it('returns both versions', function() {
+      expect(versions).toEqual(['1.0', '2.0']);
+    });
+  });
+
+  describe('#items', function() {
+    var items;
+    beforeEach(function() {
+      Documentation.items('1.0').then(function(data) {
+        items = data;
+      });
+      $scope.$apply();
+    });
+
+    it('returns all items for 1.0', function() {
+      expect(items).toEqual({
+        resources: {
+          foo: { }
         },
-        'Users': {
-          'controller': 'V1-ResourceDefinitions-Users',
-          'name': 'V1::ResourceDefinitions::Users',
-          'media_type': 'V1-MediaTypes-User'
+        schemas: {
+          bar: {}
         }
-      }
-    };
+      });
+    });
+  });
+  describe('#controller', function() {
+    var item;
+    beforeEach(function() {
+      Documentation.controller('2.0', 'test').then(function(data) {
+        item = data;
+      });
+      $scope.$apply();
+    });
+
+    it('returns all items for 1.0', function() {
+      expect(item).toEqual('TestCTRL');
+    });
+  });
+  describe('#type', function() {
+    var item;
     beforeEach(function() {
-      $httpBackend.expectGET('api/index.json').respond(response);
-      Documentation.getIndex().then(function(data) {
-        result = data;
+      Documentation.type('2.0', 'testType').then(function(data) {
+        item = data;
       });
-      $httpBackend.flush();
       $scope.$apply();
     });
 
-    it('returns the index data', function() {
-      expect(result.data).toEqual(response);
+    it('returns all items for 1.0', function() {
+      expect(item).toEqual('TestType');
     });
   });
 });

data/spec/api_browser/factories/normalize_attributes_spec.js

@@ -44,30 +44,25 @@ describe('normalizeAttributes', function() {
     test1: {
       options: {
         values: ['Hello'],
-        example: '"Hello"'
       }
     },
     test2: {
       options: {
-        example: '{\n  "test3": "Yeah",\n  "moreRecursive": {\n    "test4": 3\n  }\n}'
       },
       type: {
         attributes: {
           test3: {
             options: {
               default: 'Yeah',
-              example: '"Yeah"'
             }
           },
           moreRecursive: {
             options: {
-              example: '{\n  "test4": 3\n}'
             },
             type: {
               attributes: {
                 test4: {
                   options: {
-                    example: '3'
                   }
                 }
               }

data/spec/praxis/{types/collection_spec.rb → collection_spec.rb}

@@ -2,34 +2,28 @@ require "spec_helper"
 
 describe Praxis::Collection do
 
-  let(:type) { Volume }
-  let(:example) { Volume.example('example-volume') }
+  let(:member_type) { Volume }
 
-  let(:snapshots) { example.snapshots }
 
-  subject(:media_type_collection) do
-    Volume.attributes[:snapshots].type
+  subject!(:collection) do
+    Praxis::Collection.of(member_type)
   end
 
   context '.of' do
-    let(:media_type) do
+    let(:member_type) do
       Class.new(Praxis::MediaType) do
         identifier 'application/an-awesome-type'
       end
     end
 
-    subject!(:collection) do
-      Praxis::Collection.of(media_type)
-    end
-
     its(:identifier) { should eq 'application/an-awesome-type; type=collection' }
 
     it 'sets the collection on the media type' do
-      expect(media_type::Collection).to be(collection)
+      expect(member_type::Collection).to be(collection)
     end
 
     it 'returns an existing Collection type' do
-      expect(Praxis::Collection.of(media_type)).to be(collection)
+      expect(Praxis::Collection.of(member_type)).to be(collection)
     end
 
     it 'works with explicitly-defined collections' do
@@ -41,15 +35,34 @@ describe Praxis::Collection do
     subject(:type) { Volume::Collection }
     its(:member_type) { should be Volume }
     its(:identifier) { should eq 'application/vnd.acme.volumes' }
-
   end
 
   context '.member_type' do
-    its(:member_type){ should be(VolumeSnapshot) }
+    subject(:collection) do
+      class Team < Praxis::Collection
+        member_type Person
+      end
+      Team
+    end
+    its(:member_type){ should be(Person) }
     its(:member_attribute){ should be_kind_of(Attributor::Attribute) }
-    its('member_attribute.type'){ should be(VolumeSnapshot) }
+    its('member_attribute.type'){ should be(Person) }
+    its(:identifier) { should eq Person.identifier + "; type=collection" }
   end
-  
+
+  context '.views' do
+    subject(:views) { collection.views }
+    its(:keys) { should match_array(member_type.views.keys)}
+
+    it 'generates CollectionViews from the member views' do
+      collection.views.each do |name, view|
+        expect(view.name).to be name
+        expect(view.schema).to be member_type
+        expect(view.contents).to eq member_type.views[name].contents
+      end
+    end
+  end
+
   context '.load' do
     let(:volume_data) do
       {
@@ -86,19 +99,19 @@ describe Praxis::Collection do
   end
 
 
-   context '#render' do
-
 
+  context '#render' do
     context 'for members' do
+      let(:example) { Volume.example('example-volume') }
+      let(:snapshots) { example.snapshots }
+
       let(:volume_output) { example.render(view: :default) }
 
-      subject(:output) { volume_output[:snapshots] } 
+      subject(:output) { volume_output[:snapshots] }
 
       it { should eq(snapshots.collect(&:render)) }
     end
-
-
-   end
+  end
 
   context '#validate' do
     let(:volume_data) do
@@ -122,7 +135,7 @@ describe Praxis::Collection do
 
       let(:volume) { Volume.load(volume_data) }
       let(:snapshots) { volume.snapshots }
-      
+
       it 'validates' do
         expect(volume.validate).to be_empty
       end

data/spec/praxis/extensions/field_expansion_spec.rb

@@ -0,0 +1,96 @@
+require 'spec_helper'
+
+require 'praxis/extensions/field_selection'
+
+describe Praxis::Extensions::FieldExpansion do
+
+  # include the ActionDefinitionExtension module directly, as that's where the
+  # bulk of lies, and by including this instead of the base FieldExpansion module
+  # we avoid the side-effect of injecting the ActionDefinitionExtension into
+  # the base Praxis::ActionDefinition.
+  let(:test_class) do
+    Class.new do
+      include Praxis::Extensions::FieldExpansion::ActionDefinitionExtension
+
+      def initialize(params)
+        @params = params
+      end
+
+      attr_accessor :params
+    end
+  end
+
+  let(:test_instance) { test_class.new(test_params) }
+
+  let(:request_params) do
+    double('params',
+      fields: Praxis::Extensions::FieldSelection::FieldSelector.for(Person).load(fields),
+      view: view
+    )
+  end
+
+  let(:request) { double('Praxis::Request', params: request_params) }
+  let(:media_type) { Person }
+
+  let(:fields) { nil }
+  let(:view) { nil }
+
+  let(:test_attributes) {  }
+  let(:test_params) { double('test_params', attributes: test_attributes) }
+
+  subject(:expansion) { test_instance.expanded_fields(request, media_type)}
+
+  context '#expanded_fields' do
+
+    context 'with fields and view params defined' do
+      let(:test_attributes) { {view: true, fields: true}  }
+
+      context 'and no fields provided' do
+        it 'returns the fields for the default view' do
+          expect(expansion).to eq({id: true, name: true, links: [true]})
+        end
+
+        context 'and a view' do
+          let(:view) { :link }
+          it 'expands the fields on the view' do
+            expect(expansion).to eq({id: true, name: true, href: true})
+          end
+        end
+      end
+
+      context 'with a set of fields provided' do
+        let(:fields) { 'id,name,owner{name}' }
+        it 'returns the subset of fields for the default view' do
+          expected = {id: true, name: true }
+          expect(expansion).to eq expected
+        end
+
+        context 'and a view' do
+          let(:view) { :link }
+          let(:fields) { 'id,href' }
+
+          it 'returns the subset of fields that exist for the view' do
+            expected = {id: true, href: true }
+            expect(expansion).to eq expected
+          end
+        end
+      end
+    end
+
+    context 'with only a view param defined' do
+      let(:test_attributes) { {view: true}  }
+
+      it 'returns the fields for the default view' do
+        expect(expansion).to eq({id: true, name: true, links: [true]})
+      end
+
+      context 'and a view' do
+        let(:view) { :link }
+        it 'expands the fields on the view' do
+          expect(expansion).to eq({id: true, name: true, href: true})
+        end
+      end
+    end
+  end
+
+end