mobile_workflow 0.5.11 → 0.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24e4161405736a8da53f830ee7f46f84a58930a3f4d7e5fd28456005f4d1f99f
-  data.tar.gz: 9f13aa23db9a97150e0c0bd9c3a64b6b5161460df709c14a56a2af87ce3db784
+  metadata.gz: 2d3b107beb896ad8c143fe376e7532d3f7d3093435f1b0b59a15401dba17d752
+  data.tar.gz: '097097c10f64a32065c90e42779b672fecd4b964a15eb43e887d686718c3acfb'
 SHA512:
-  metadata.gz: 2e6056e6a06c99156d2106114ea885caedf5eb5ec83d62a02469aa645b7fb2498ab4ccf5fcc73bd1de5def857f64b8532fc65e669c870ed073d865e7c228d7e5
-  data.tar.gz: 8e6fc1fd000da48eddc130b84dec03ee8c1db5a0a1e95a5783d544a0fd720e364800b2c9b8cd769e222817a1304e4d32892664b61e159ae63c5520f1be132e71
+  metadata.gz: c8fea51abb663711210ef86a67a8a2b5bcaaedd95d8772fb1297d6deaa10ee4142af6a0a2a6948db56f088da31aa26833b580c6ed7be994c16df6884338394dd
+  data.tar.gz: 41fee4840d3925030a310530cca5f778a1b989d5f37bea0c8fc7440d3947d04fade3ac3abf040b0f6bf6a0e3508b492b840871c7c73c50fb7b9201decf8703b7

data/lib/generators/mobile_workflow/controller_generator.rb

@@ -9,6 +9,7 @@ module MobileWorkflow
       class_option :attributes, type: :array, default: [], banner: "field:type field:type"
       class_option :actions, type: :array, default: [], banner: "index create update destroy"
       class_option :doorkeeper_oauth, type: :boolean, default: false
+      class_option :s3_storage, type: :boolean, default: false
       
       def copy_controller_and_spec_files
         template "controller.rb.erb", File.join("app/controllers", controller_class_path, "#{controller_file_name}_controller.rb")
@@ -20,6 +21,10 @@ module MobileWorkflow
         options[:doorkeeper_oauth]
       end
       
+      def s3_storage?
+        options[:s3_storage]
+      end
+      
       def attributes_names
         options[:attributes].map{ |attribute| attribute.split(":").first }
       end

data/lib/generators/mobile_workflow/install/install_generator.rb

@@ -1,16 +1,15 @@
 require "rails/generators/base"
+require "mobile_workflow/open_api_spec/parser"
 
 module MobileWorkflow
   module Generators
     class InstallGenerator < Rails::Generators::Base
       
-      # Schemas to avoid generating models for (static items from MW)
-      SKIP_SCHEMAS = ["attachment", "ListItem", "DisplayItem", "DisplayText", "DisplayButton", "DisplayImage", "DisplayVideo"]
-      
       source_root File.expand_path("../templates", __FILE__)
 
       class_option :open_api_spec_path, type: :string, default: "config/open_api_spec.json"
       class_option :doorkeeper_oauth, type: :boolean, default: false
+      class_option :s3_storage, type: :boolean, default: false
       class_option :interactive, type: :boolean, default: false
 
       def create_api_controller
@@ -40,26 +39,34 @@ module MobileWorkflow
       end
       
       def generate_models
+        say "Loading OpenAPI Spec: #{open_api_spec_path}"
         say "Generating models"
-        @model_properties = {}
-        open_api_spec[:components][:schemas].each_pair do |model_name, schema|
-          next if SKIP_SCHEMAS.include? model_name # Don't generate schemas for MW schemas
-        
-          model_name = model_name.underscore
-          model_properties = model_properties(model_name, schema)
-          generate(:model, "#{model_name} #{model_properties}")
-          @model_properties[model_name] = model_properties
+        model_name_to_properties.each_pair do |model_name, model_properties|          
+          if interactive? && !yes?("Use generated schema #{model_name}(#{model_properties})[yn]?")
+            model_properties = ask "Specify schema for #{model_name}: (e.g. text:string image:attachment region:reference)"
+          end
+
+          generate_model(model_name, model_properties)
+          @model_name_to_properties[model_name] = model_properties
         end
       end
 
       def generate_controllers_and_routes
         say "Generating controllers"
-        route "root to: 'admin/#{controller_names.first}#index'"
+        route "root to: 'admin/#{open_api_spec.controller_names.first}#index'"
         
-        controller_names.each do |plural_controller_name|
+        open_api_spec.controller_names.each do |plural_controller_name|
           controller_name = plural_controller_name.singularize
-          model_properties = @model_properties[controller_name]
-          generate "mobile_workflow:controller #{controller_name} --attributes #{model_properties}"
+          model_properties = model_name_to_properties[controller_name]
+          
+          unless model_properties
+            # Generate a model because it probably wasnt present in the schema
+            # And set default attributes
+            model_properties = "text:string"
+            generate_model(controller_name, model_properties)
+          end
+          
+          generate "mobile_workflow:controller #{controller_name} --attributes #{model_properties} #{s3_storage? ? '--s3-storage' : ''}".strip
           route "resources :#{plural_controller_name}, only: [:index, :show, :create]"
         end
       end
@@ -69,21 +76,21 @@ module MobileWorkflow
       end
 
       private
-      def controller_names
-        @controller_names ||= oai_spec_paths.collect{|url_path| url_path.split('/')[1] }.uniq
+      
+      def generate_model(model_name, model_properties)
+        generate("mobile_workflow:model #{model_name} #{model_properties}")
       end
       
-      def oai_spec_paths
-        @oai_spec_paths ||= open_api_spec[:paths].keys
+      def model_name_to_properties
+        @model_name_to_properties ||= open_api_spec.model_name_to_properties
       end
       
       def open_api_spec
-        @open_api_spec ||= read_openapi_spec
+        @open_api_spec ||= ::MobileWorkflow::OpenApiSpec::Parser.new(File.read(open_api_spec_path))
       end
       
-      def read_openapi_spec
-        say "Loading OpenAPI Spec: #{open_api_spec_path}" 
-        return JSON.parse(File.read(open_api_spec_path)).with_indifferent_access 
+      def s3_storage?
+        options[:s3_storage]
       end
       
       def open_api_spec_path
@@ -93,22 +100,6 @@ module MobileWorkflow
       def interactive?
         options[:interactive]
       end
-      
-      def model_properties(name, schema)
-        generated_properties_args = schema["properties"].keys.collect{|key| "#{key}:#{model_property_type(schema["properties"][key])}" }.join(" ")
-        if !interactive? || yes?("Use generated schema #{name}(#{generated_properties_args})[yn]?")
-          generated_properties_args
-        else
-          ask "Specify schema for #{name}: (e.g. text:string image:attachment region:reference)"
-        end      
-      end
-      
-      def model_property_type(property)
-        return property["type"] unless property["type"].blank?
-        return 'attachment' if property['$ref'] == "#/components/schemas/attachment"
-        
-        raise 'Unknown property type'
-      end
     end
   end
 end

data/lib/generators/mobile_workflow/install/templates/Gemfile.erb

@@ -31,6 +31,9 @@ gem 'aws-sdk-s3', '~> 1.60', '>= 1.60.1'
 gem 'aws-sdk-sns', '~> 1.23'
 <%- end %>
 
+# FFI for Mac M1
+gem 'ffi', github: 'ffi/ffi'
+
 group :development do
   gem 'web-console', '>= 3.3.0'
   gem 'listen', '>= 3.0.5', '< 3.2'

data/lib/generators/mobile_workflow/model_generator.rb

@@ -0,0 +1,15 @@
+require 'rails/generators/active_record/model/model_generator'
+
+module MobileWorkflow
+  module Generators
+
+    class ModelGenerator < ActiveRecord::Generators::ModelGenerator
+      source_root File.join(File.dirname(ActiveRecord::Generators::ModelGenerator.instance_method(:create_migration_file).source_location.first), "templates")
+      
+      def create_model_file
+        template File.join(File.dirname(__FILE__), "templates", "model.rb.erb"), File.join('app/models', class_path, "#{file_name}.rb")
+      end
+      
+    end
+  end
+end

data/lib/generators/mobile_workflow/templates/controller.rb.erb

@@ -1,6 +1,6 @@
 <% module_namespacing do -%>
 class <%= controller_class_name %>Controller < ApiController
-  # include MobileWorkflow::S3Storable
+  <%= s3_storage? ? "include MobileWorkflow::S3Storable" : "" %>
   before_action :rewrite_payload, only: :create
 
   load_and_authorize_resource
@@ -15,7 +15,11 @@ class <%= controller_class_name %>Controller < ApiController
 
   def create
     if @<%= singular_table_name %>.save
+      <% if s3_storage? -%>
       render json: { binary_urls: binary_urls(@<%= singular_table_name %>), response: @<%= singular_table_name %> }, status: :created
+      <% else -%>
+      render json: { response: @<%= singular_table_name %> }, status: :created      
+      <% end -%>
     else
       head :unprocessable_entity 
     end

data/lib/generators/mobile_workflow/templates/controller_spec.rb.erb

@@ -54,7 +54,9 @@ RSpec.describe <%= controller_class_name %>Controller do
     context 'ok' do
       it { expect(<%= controller_class_name.singularize %>.count).to eq 1 }          
       it { expect(response.status).to eq 201 }
+      <% if s3_storage? -%>
       it { expect(json_response[:binary_urls]).to_not be_nil }
+      <% end %>
     end
   end
 end

data/lib/{templates/active_record/model → generators/mobile_workflow/templates}/model.rb.erb

@@ -13,11 +13,14 @@ class <%= class_name %> < <%= parent_class_name.classify %>
 <% end -%>
 
   def list_item_as_json
-    mw_list_item(text: text)
+    mw_list_item(text: <%= attributes.first.name %>)
   end
   
   def display_as_json
-    [mw_display_text(label: 'ID', text: id.to_s)]
+    [
+      mw_display_text(label: 'ID', text: id.to_s),
+      mw_display_text(label: 'Text', text: <%= attributes.first.name %>)
+    ]
   end
 
 end

data/lib/mobile_workflow/cli/app_builder.rb

@@ -16,6 +16,12 @@ module MobileWorkflow::Cli
     def rspec_generator
       generate 'rspec:install'
     end
+    
+    def factory_bot
+      inject_into_file 'spec/rails_helper.rb', before: "end\n" do
+        "config.include FactoryBot::Syntax::Methods"
+      end
+    end
 
     def administrate_generator
       Bundler.with_unbundled_env { generate 'administrate:install' }

data/lib/mobile_workflow/cli/app_server_generator.rb

@@ -33,6 +33,7 @@ module MobileWorkflow::Cli
       after_bundle do
         build :procfiles
         build :rspec_generator
+        build :factory_bot
         build :ability_generator
         build :active_storage if options[:s3_storage] 
         build :mobile_workflow_generator, ARGV[1]

data/lib/mobile_workflow/open_api_spec/parser.rb

@@ -0,0 +1,59 @@
+module MobileWorkflow
+  module OpenApiSpec
+    class Parser
+  
+      # Schemas to avoid generating models for (static items from MW)
+      SKIP_SCHEMAS = ["attachment", "ListItem", "DisplayItem", "DisplayText", "DisplayButton", "DisplayImage", "DisplayVideo"]
+  
+      def initialize(open_api_spec_string)
+        @open_api_spec_string = open_api_spec_string
+      end
+  
+      def model_name_to_properties
+        @model_properties = {}
+        schemas.each_pair do |model_name, schema|
+          next if SKIP_SCHEMAS.include? model_name # Don't generate schemas for MW schemas
+    
+          model_name = model_name.underscore
+          model_properties = schema_model_properties(model_name, schema)
+      
+          @model_properties[model_name] = model_properties
+        end
+        @model_properties
+      end
+  
+      def controller_names
+        @controller_names ||= paths.collect{|url_path| url_path.split('/')[1] }.uniq
+      end
+  
+      def paths
+        @paths ||= open_api_spec[:paths].keys
+      end
+  
+      def schemas
+        @schemas ||= open_api_spec[:components][:schemas]
+      end
+  
+      private
+      def open_api_spec
+        @open_api_spec ||= read_openapi_spec
+      end
+  
+      def schema_model_properties(name, schema)
+        schema["properties"].keys.collect{|key| "#{key}:#{model_property_type(schema["properties"][key])}" }.join(" ")  
+      end
+  
+      def model_property_type(property)
+        return property["type"] unless property["type"].blank?
+        return 'attachment' if property['$ref'] == "#/components/schemas/attachment"
+    
+        raise 'Unknown property type'
+      end
+  
+      def read_openapi_spec
+        @read_openapi_spec ||= JSON.parse(@open_api_spec_string).with_indifferent_access 
+      end
+  
+    end
+  end
+end

data/lib/mobile_workflow/version.rb

@@ -1,5 +1,5 @@
 module MobileWorkflow
-  VERSION = '0.5.11'
+  VERSION = '0.6.4'
   RUBY_VERSION = '2.7.2'
   RAILS_VERSION = '6.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mobile_workflow
 version: !ruby/object:Gem::Version
-  version: 0.5.11
+  version: 0.6.4
 platform: ruby
 authors:
 - Matt Brooke-Smith
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-19 00:00:00.000000000 Z
+date: 2021-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -119,8 +119,10 @@ files:
 - lib/generators/mobile_workflow/install/templates/user.rb.erb
 - lib/generators/mobile_workflow/install/templates/views/layouts/application.html.erb
 - lib/generators/mobile_workflow/install/templates/views/sessions/new.html.erb
+- lib/generators/mobile_workflow/model_generator.rb
 - lib/generators/mobile_workflow/templates/controller.rb.erb
 - lib/generators/mobile_workflow/templates/controller_spec.rb.erb
+- lib/generators/mobile_workflow/templates/model.rb.erb
 - lib/mobile_workflow.rb
 - lib/mobile_workflow/cli.rb
 - lib/mobile_workflow/cli/app_builder.rb
@@ -130,8 +132,8 @@ files:
 - lib/mobile_workflow/cli/dokku_backend.rb
 - lib/mobile_workflow/cli/heroku_backend.rb
 - lib/mobile_workflow/engine.rb
+- lib/mobile_workflow/open_api_spec/parser.rb
 - lib/mobile_workflow/version.rb
-- lib/templates/active_record/model/model.rb.erb
 homepage: https://github.com/futureworkshops/mobile_workflow
 licenses:
 - MIT