praxis 2.0.pre.18 → 2.0.pre.19

data/tasks/thor/model.rb

@@ -4,23 +4,23 @@ module PraxisGen
   class Model < Thor
     require 'active_support/inflector'
     include Thor::Actions
-    
+
     def self.source_root
-      File.dirname(__FILE__) + "/templates/generator/scaffold"
+      "#{File.dirname(__FILE__)}/templates/generator/scaffold"
     end
 
-    desc "gmodel", "Generates a skeleton model file under app/models for ActiveRecord or Sequel."
+    desc 'gmodel', 'Generates a skeleton model file under app/models for ActiveRecord or Sequel.'
     argument :model_name, required: true
-    option :orm, required: false, default: 'activerecord', enum: ['activerecord','sequel']
+    option :orm, required: false, default: 'activerecord', enum: %w[activerecord sequel]
     def g
-      #self.class.check_name(model_name)
+      # self.class.check_name(model_name)
       template_file = \
         if options[:orm] == 'activerecord'
           'models/active_record.rb'
         else
           'models/sequel.rb'
         end
-      puts "Generating Model for #{model_name}"        
+      puts "Generating Model for #{model_name}"
       template template_file, "app/models/#{model_name}.rb"
       nil
     end
@@ -34,7 +34,7 @@ module PraxisGen
     # TODO: do we want the argument to be camelcase? or snake case?
     def self.check_name(name)
       sanitized = name.downcase.gsub(/[^a-z0-9_]/, '')
-      raise "Please use only downcase letters, numbers and underscores for the model" unless sanitized == name
+      raise 'Please use only downcase letters, numbers and underscores for the model' unless sanitized == name
     end
   end
 end

data/tasks/thor/scaffold.rb

@@ -4,32 +4,32 @@ module PraxisGen
   class Scaffold < Thor
     require 'active_support/inflector'
     include Thor::Actions
-    
+
     attr_reader :actions_hash
 
     def self.source_root
-      File.dirname(__FILE__) + "/templates/generator/scaffold"
+      "#{File.dirname(__FILE__)}/templates/generator/scaffold"
     end
 
-    desc "g","Generates an API design and implementation scaffold for managing a collection of <collection_name>"
+    desc 'g', 'Generates an API design and implementation scaffold for managing a collection of <collection_name>'
     argument :collection_name, required: true
     option :version, required: false, default: '1',
-    desc: 'Version string for the API endpoint. This also dictates the directory structure (i.e., v1/endpoints/...))'
+                     desc: 'Version string for the API endpoint. This also dictates the directory structure (i.e., v1/endpoints/...))'
     option :design, type: :boolean, default: true,
-        desc: 'Include the Endpoint and MediaType files for the collection'
+                    desc: 'Include the Endpoint and MediaType files for the collection'
     option :implementation, type: :boolean, default: true,
-        desc: 'Include the Controller and (possibly the) Resource files for the collection (see --no-resource)'
+                            desc: 'Include the Controller and (possibly the) Resource files for the collection (see --no-resource)'
     option :resource, type: :boolean, default: true,
-        desc: 'Disable (or enable) the creation of the Resource files when generating implementation'
-    option :model, type: :string, enum: ['activerecord','sequel'],
-        desc: 'It also generates a model for the given ORM. An empty --model flag will default to activerecord'
-    option :actions, type: :string, default: 'crud', enum: ['cr','cru','crud','u','ud','d'],
-        desc: 'Specifies the actions to generate for the API. cr=create, u=update, d=delete. Index and show actions are always generated'
+                      desc: 'Disable (or enable) the creation of the Resource files when generating implementation'
+    option :model, type: :string, enum: %w[activerecord sequel],
+                   desc: 'It also generates a model for the given ORM. An empty --model flag will default to activerecord'
+    option :actions, type: :string, default: 'crud', enum: %w[cr cru crud u ud d],
+                     desc: 'Specifies the actions to generate for the API. cr=create, u=update, d=delete. Index and show actions are always generated'
     def g
       self.class.check_name(collection_name)
       @actions_hash = self.class.compose_actions_hash(options[:actions])
-      env_rb = Pathname.new(destination_root)+Pathname.new("config/environment.rb")
-      @pagination_plugin_found = File.open(env_rb).grep(/Praxis::Plugins::PaginationPlugin.*/).reject{|l| l.strip[0] == '#'}.present?
+      env_rb = Pathname.new(destination_root) + Pathname.new('config/environment.rb')
+      @pagination_plugin_found = File.open(env_rb).grep(/Praxis::Plugins::PaginationPlugin.*/).reject { |l| l.strip[0] == '#' }.present?
       if options[:design]
         say_status 'Design', "Generating scaffold for #{plural_class}", :blue
         template 'design/media_types/item.rb', "design/#{version_dir}/media_types/#{collection_name.singularize}.rb"
@@ -38,14 +38,14 @@ module PraxisGen
       if options[:implementation]
         say_status 'Implement', "Generating scaffold for #{plural_class}", :blue
         if options[:resource]
-          base_resource = Pathname.new(destination_root)+Pathname.new("app/#{version_dir}/resources/base.rb")
+          base_resource = Pathname.new(destination_root) + Pathname.new("app/#{version_dir}/resources/base.rb")
           unless base_resource.exist?
             # Copy an appropriate base resource for the version (resources within same version must share same base)
-            say_status "NOTE:", 
-              "Creating a base resource file for resources to inherit from (at 'app/#{version_dir}/resources/base.rb')", 
-              :yellow
-            say_status "", 
-              "If you had already other resources in the app, change them to derive from this Base"
+            say_status 'NOTE:',
+                       "Creating a base resource file for resources to inherit from (at 'app/#{version_dir}/resources/base.rb')",
+                       :yellow
+            say_status '',
+                       'If you had already other resources in the app, change them to derive from this Base'
             template 'implementation/resources/base.rb', "app/#{version_dir}/resources/base.rb"
           end
           template 'implementation/resources/item.rb', "app/#{version_dir}/resources/#{collection_name.singularize}.rb"
@@ -60,11 +60,11 @@ module PraxisGen
       def plural_class
         collection_name.camelize
       end
-    
+
       def singular_class
         collection_name.singularize.camelize
       end
-      
+
       def version
         options[:version]
       end
@@ -72,7 +72,7 @@ module PraxisGen
       def version_module
         "V#{version}"
       end
-    
+
       def version_dir
         version_module.camelize(:lower)
       end
@@ -111,7 +111,7 @@ module PraxisGen
     def self.check_name(name)
       sanitized = name.downcase.gsub(/[^a-z0-9_]/, '')
       # TODO: bail or support CamelCase collections (for now only snake case)
-      raise "Please use only downcase letters, numbers and underscores for the collection" unless sanitized == name
+      raise 'Please use only downcase letters, numbers and underscores for the collection' unless sanitized == name
     end
   end
 end

data/tasks/thor/templates/generator/example_app/app/v1/resources/user.rb

@@ -5,14 +5,6 @@ module V1
     class User < Base
       model ::User
 
-      # Mappings for the allowed filters
-      filters_mapping(
-        'uuid': 'uuid',
-        'first_name': 'first_name',
-        'last_name': 'last_name',
-        'email': 'email'
-      )
-
       # To compute the full_name (method below) we need to load first and last names from the DB
       property :full_name, dependencies: %i[first_name last_name]
 

data/tasks/thor/templates/generator/scaffold/implementation/resources/item.rb

@@ -6,9 +6,8 @@ module <%= version_module %>
       model ::<%= singular_class %> # Change it if it maps to a different DB model class
 
       # Define the name mapping from API filter params, to model attribute/associations
-      # when they aren't 1:1
+      # when they aren't 1:1 the same
       # filters_mapping(
-      #   'name': 'name',
       #   'label': 'association.label_name'
       # )
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: praxis
 version: !ruby/object:Gem::Version
-  version: 2.0.pre.18
+  version: 2.0.pre.19
 platform: ruby
 authors:
 - Josep M. Blanquer
@@ -9,56 +9,36 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-22 00:00:00.000000000 Z
+date: 2022-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rack
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1'
-- !ruby/object:Gem::Dependency
-  name: mustermann
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.1'
-    - - "<="
-      - !ruby/object:Gem::Version
-        version: '2'
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.1'
-    - - "<="
-      - !ruby/object:Gem::Version
-        version: '2'
+        version: '3'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: attributor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: mime
   requirement: !ruby/object:Gem::Requirement
@@ -74,33 +54,39 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: attributor
+  name: mustermann
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '1.1'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '1.1'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
-  name: thor
+  name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: terminal-table
   requirement: !ruby/object:Gem::Requirement
@@ -115,6 +101,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: thor
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -200,49 +200,49 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec-its
+  name: fuubar
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '2'
 - !ruby/object:Gem::Dependency
-  name: rspec-collection_matchers
+  name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '2'
 - !ruby/object:Gem::Dependency
-  name: guard
+  name: guard-bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -270,75 +270,81 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4'
 - !ruby/object:Gem::Dependency
-  name: guard-bundler
+  name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rack-test
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rspec-collection_matchers
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
 - !ruby/object:Gem::Dependency
-  name: fuubar
+  name: rspec-its
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '1'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: sequel
   requirement: !ruby/object:Gem::Requirement
@@ -353,20 +359,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5'
-- !ruby/object:Gem::Dependency
-  name: activerecord
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: '4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: '4'
 description: 
 email:
 - blanquer@gmail.com
@@ -378,6 +370,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".ruby-version"
 - ".simplecov"
 - ".travis.yml"
@@ -386,11 +379,9 @@ files:
 - Gemfile
 - Guardfile
 - LICENSE
-- MAINTAINERS
 - MAINTAINERS.md
 - README.md
 - Rakefile
-- TODO.md
 - bin/praxis
 - lib/praxis.rb
 - lib/praxis/action_definition.rb
@@ -469,7 +460,7 @@ files:
 - lib/praxis/handlers/json.rb
 - lib/praxis/handlers/plain.rb
 - lib/praxis/handlers/www_form.rb
-- lib/praxis/handlers/xml-sample.rb
+- lib/praxis/handlers/xml_sample.rb
 - lib/praxis/mapper/active_model_compat.rb
 - lib/praxis/mapper/resource.rb
 - lib/praxis/mapper/selector_generator.rb
@@ -527,7 +518,6 @@ files:
 - spec/praxis/action_definition_spec.rb
 - spec/praxis/api_definition_spec.rb
 - spec/praxis/api_general_info_spec.rb
-- spec/praxis/api_resource_spec.rb
 - spec/praxis/application_spec.rb
 - spec/praxis/blueprint_spec.rb
 - spec/praxis/bootloader_spec.rb
@@ -536,7 +526,6 @@ files:
 - spec/praxis/config_hash_spec.rb
 - spec/praxis/config_spec.rb
 - spec/praxis/controller_spec.rb
-- spec/praxis/dispatcher_spec.rb
 - spec/praxis/endpoint_definition_spec.rb
 - spec/praxis/extensions/attribute_filtering/active_record_filter_query_builder_spec.rb
 - spec/praxis/extensions/attribute_filtering/filter_tree_node_spec.rb
@@ -584,7 +573,6 @@ files:
 - spec/spec_app/app/controllers/base_class.rb
 - spec/spec_app/app/controllers/instances.rb
 - spec/spec_app/app/controllers/volumes.rb
-- spec/spec_app/app/responses/bulk_response.rb
 - spec/spec_app/app/responses/multipart.rb
 - spec/spec_app/app/responses/other_response.rb
 - spec/spec_app/config.ru
@@ -680,7 +668,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.1'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"

data/MAINTAINERS

@@ -1,2 +0,0 @@
-Josep Blanquer <blanquer@gmail.com> (@blanquer)
-Dane Jensen <dane.jensen@gmail.com>

data/TODO.md

@@ -1,25 +0,0 @@
-# TODO
-
-## Things to delete
-
- * views (just use a sensible default view of just simple types?)
- * remove collection summary things...
- * FieldResolver?? and that conditional dependency thing...?
- * simplify or change examples? ...maybe get rid of randexp.
- * NOTE: make sure the types we use only expose the json-schema types...no longer things like Hash/Struct/Symbol ...(that might be good only for coding/implementation, not for documentation)
- * Plugins? ... maybe leave them out for the moment?
- * change errors to be machine readable
- * change naming of resource definition to endpoint definition
- * get rid of deprecations
- 
-
- ## DONE
- * remove links and link_builder
- * remove xml handlers for parsing and rendering. (same for url-encoding) -- (which would allow nil-setting things)
-* remove route aliases, named routes...and primary route concepts
-
-
- NOTES:
- APIGeneralInfo: consumes and produces (make that the default if it isn't...)
- maybe remove Praxis::Handlers::WWWForm AND  Praxis::Handlers::XML ? or stash them away as examples...
-