mobile_workflow 0.10.2 → 0.12.0

data/lib/mobile_workflow/cli/dokku_backend.rb

@@ -1,57 +1,60 @@
-module MobileWorkflow::Cli
-  class DokkuBackend
-    def initialize(dokku_host:, app_name:)
-      @dokku_host = dokku_host
-      @dokku_app_name = app_name.gsub("_", "-")
-    end
-  
-    def create
-      remote_command "dokku apps:create #{@dokku_app_name}"
-      remote_command "dokku postgres:create #{@dokku_app_name}"
-      remote_command "dokku postgres:link #{@dokku_app_name} #{@dokku_app_name}"
-      remote_command "dokku domains:enable #{@dokku_app_name}"
-      remote_command "dokku letsencrypt #{@dokku_app_name}"
-    
-      local_command "git remote add dokku dokku@#{@dokku_host}:#{@dokku_app_name}"
-    end
-  
-    def configure_activestorage
- 
-    end
-  
-    def deploy
-      local_command "git push dokku master"
-    end
-  
-    def sync_dotenv
-      env = File.read(".env").split.join(" ")
-      puts "Setting env: #{env}"
-      local_command "dokku config:set #{env}"
-    end
-  
-    def destroy
-      remote_command "dokku apps:destroy #{@dokku_app_name}"
-    end
-  
-    def dokku_app_host
-      remote_command "dokku url #{@dokku_app_name}"
-    end
-  
-    def notifications_endpoint
-      "https://#{dokku_app_host}/sns_notifications"
-    end
-  
-    private
-    def remote_command(command)
-      command = "ssh -t ubuntu@#{@dokku_host} '#{command}'"
-      local_command(command)
-    end
-  
-    def local_command(command)
-      puts "Running: #{command}"
-      output = `#{command}`
-      puts "Output: #{output}" unless output.blank?
-      return output
+# frozen_string_literal: true
+
+module MobileWorkflow
+  module Cli
+    class DokkuBackend
+      def initialize(dokku_host:, app_name:)
+        @dokku_host = dokku_host
+        @dokku_app_name = app_name.gsub('_', '-')
+      end
+
+      def create
+        remote_command "dokku apps:create #{@dokku_app_name}"
+        remote_command "dokku postgres:create #{@dokku_app_name}"
+        remote_command "dokku postgres:link #{@dokku_app_name} #{@dokku_app_name}"
+        remote_command "dokku domains:enable #{@dokku_app_name}"
+        remote_command "dokku letsencrypt #{@dokku_app_name}"
+
+        local_command "git remote add dokku dokku@#{@dokku_host}:#{@dokku_app_name}"
+      end
+
+      def configure_activestorage; end
+
+      def deploy
+        local_command 'git push dokku master'
+      end
+
+      def sync_dotenv
+        env = File.read('.env').split.join(' ')
+        puts "Setting env: #{env}"
+        local_command "dokku config:set #{env}"
+      end
+
+      def destroy
+        remote_command "dokku apps:destroy #{@dokku_app_name}"
+      end
+
+      def dokku_app_host
+        remote_command "dokku url #{@dokku_app_name}"
+      end
+
+      def notifications_endpoint
+        "https://#{dokku_app_host}/sns_notifications"
+      end
+
+      private
+
+      def remote_command(command)
+        command = "ssh -t ubuntu@#{@dokku_host} '#{command}'"
+        local_command(command)
+      end
+
+      def local_command(command)
+        puts "Running: #{command}"
+        output = `#{command}`
+        puts "Output: #{output}" unless output.blank?
+        output
+      end
     end
   end
-end
+end

data/lib/mobile_workflow/cli/heroku_backend.rb

@@ -1,51 +1,56 @@
-module MobileWorkflow::Cli
-  class HerokuBackend
-    def initialize(app_name:)
-      @heroku_app_name = app_name.gsub("_", "-")
-    end
-  
-    def create
-      heroku_command "heroku create #{@heroku_app_name}"
-      heroku_command "git push --set-upstream heroku master"
-    end
-  
-    def configure_activestorage
-      heroku_command "heroku buildpacks:add -i 1 https://github.com/heroku/heroku-buildpack-activestorage-preview --app #{@heroku_app_name}"
-      heroku_command "heroku labs:enable runtime-dyno-metadata --app #{@heroku_app_name}" # Gives access to heroku variables which can be used to construct URLs
-    
-      # Force recompile after buildpacks change
-      heroku_command "git commit --allow-empty -m 'empty commit'"
-      deploy    
-    end
-  
-    def deploy
-      heroku_command "git push"
-    end
-    
-    def seed_db
-      heroku_command "heroku run rails db:seed"
-    end
-  
-    def sync_dotenv
-      env = File.read(".env").split.join(" ")
-      puts "Setting env: #{env}"
-      heroku_command "heroku config:set #{env} --app #{@heroku_app_name}"
-    end
-  
-    def destroy
-      heroku_command "heroku destroy #{@heroku_app_name} --confirm #{@heroku_app_name}"
-    end
-  
-    def notifications_endpoint
-      "https://#{@heroku_app_name}.herokuapp.com/sns_notifications"
-    end
-  
-    private
-    def heroku_command(command)
-      puts "Running: #{command}"
-      output = `#{command}`
-      puts "Output: #{output}"
-      return output
+# frozen_string_literal: true
+
+module MobileWorkflow
+  module Cli
+    class HerokuBackend
+      def initialize(app_name:)
+        @heroku_app_name = app_name.gsub('_', '-')
+      end
+
+      def create
+        heroku_command "heroku create #{@heroku_app_name}"
+        heroku_command 'git push --set-upstream heroku master'
+      end
+
+      def configure_activestorage
+        heroku_command "heroku buildpacks:add -i 1 https://github.com/heroku/heroku-buildpack-activestorage-preview --app #{@heroku_app_name}"
+        heroku_command "heroku labs:enable runtime-dyno-metadata --app #{@heroku_app_name}" # Gives access to heroku variables which can be used to construct URLs
+
+        # Force recompile after buildpacks change
+        heroku_command "git commit --allow-empty -m 'empty commit'"
+        deploy
+      end
+
+      def deploy
+        heroku_command 'git push'
+      end
+
+      def seed_db
+        heroku_command 'heroku run rails db:seed'
+      end
+
+      def sync_dotenv
+        env = File.read('.env').split.join(' ')
+        puts "Setting env: #{env}"
+        heroku_command "heroku config:set #{env} --app #{@heroku_app_name}"
+      end
+
+      def destroy
+        heroku_command "heroku destroy #{@heroku_app_name} --confirm #{@heroku_app_name}"
+      end
+
+      def notifications_endpoint
+        "https://#{@heroku_app_name}.herokuapp.com/sns_notifications"
+      end
+
+      private
+
+      def heroku_command(command)
+        puts "Running: #{command}"
+        output = `#{command}`
+        puts "Output: #{output}"
+        output
+      end
     end
   end
-end
+end

data/lib/mobile_workflow/cli.rb

@@ -1,9 +1,11 @@
-require "mobile_workflow/version"
+# frozen_string_literal: true
 
-require "mobile_workflow/cli/app_server_generator"
-require "mobile_workflow/cli/app_builder"
-require "mobile_workflow/cli/app_server_cleaner"
+require 'mobile_workflow/version'
 
-require "mobile_workflow/cli/aws_backend"
-require "mobile_workflow/cli/heroku_backend"
-require "mobile_workflow/cli/dokku_backend"
+require 'mobile_workflow/cli/app_server_generator'
+require 'mobile_workflow/cli/app_builder'
+require 'mobile_workflow/cli/app_server_cleaner'
+
+require 'mobile_workflow/cli/aws_backend'
+require 'mobile_workflow/cli/heroku_backend'
+require 'mobile_workflow/cli/dokku_backend'

data/lib/mobile_workflow/deprecated.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module MobileWorkflow
+  module Deprecated
+    # Define a deprecated alias for a method
+    # @param [Symbol] name - name of method to define
+    # @param [Symbol] replacement - name of method to (alias)
+    def deprecated_alias(name, replacement)
+      # Create a wrapped version
+      define_method(name) do |*args, &block|
+        warn "MobileWorkflow: ##{name} deprecated (please use ##{replacement})"
+        send replacement, *args, &block
+      end
+    end
+
+    # Deprecate a defined method
+    # @param [Symbol] name - name of deprecated method
+    # @param [Symbol] replacement - name of the desired replacement
+    def deprecated(name, replacement = nil)
+      # Replace old method
+      old_name = :"#{name}_without_deprecation"
+      alias_method old_name, name
+      # And replace it with a wrapped version
+      define_method(name) do |*args, &block|
+        if replacement
+          warn "MobileWorkflow: ##{name} deprecated (please use ##{replacement})"
+        else
+          warn "MobileWorkflow: ##{name} deprecated"
+        end
+        send old_name, *args, &block
+      end
+    end
+  end
+end

data/lib/mobile_workflow/engine.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module MobileWorkflow
   if defined?(Rails)
     class Engine < ::Rails::Engine
       isolate_namespace MobileWorkflow
-      
+
       config.generators do |g|
         g.test_framework :rspec
       end

data/lib/mobile_workflow/open_api_spec/parser.rb

@@ -1,72 +1,73 @@
+# frozen_string_literal: true
+
 module MobileWorkflow
   module OpenApiSpec
     class Parser
-  
       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 model_name.start_with?("MW")
-    
+          next if model_name.start_with?('MW')
+
           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_name_to_actions
         @controller_name_to_actions ||= parse_controller_names_to_actions
       end
-  
+
       def paths
         @paths ||= open_api_spec[:paths].keys
       end
-  
+
       def schemas
         @schemas ||= open_api_spec[:components][:schemas]
       end
-  
+
       private
+
       def parse_controller_names_to_actions
         controllers = {}
         paths.each do |path|
           path_items = path.split('/')
           controller_name = path_items[1]
           controllers[controller_name] = [] unless controllers.key?(controller_name)
-          
-          open_api_spec[:paths][path].keys.each do |method|
+
+          open_api_spec[:paths][path].each_key do |method|
             controllers[controller_name] << 'create' if path_items.count == 2 && method == 'post'
             controllers[controller_name] << 'index' if path_items.count == 2 && method == 'get'
-            controllers[controller_name] << 'show' if path_items.count == 3 && method == 'get'                        
+            controllers[controller_name] << 'show' if path_items.count == 3 && method == 'get'
           end
         end
         controllers
       end
-      
+
       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(" ")  
+
+      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/MWAttachment"
-    
+        return property['type'] unless property['type'].blank?
+        return 'attachment' if property['$ref'] == '#/components/schemas/MWAttachment'
+
         raise "Unknown property type: #{property}"
       end
-  
+
       def read_openapi_spec
-        @read_openapi_spec ||= JSON.parse(@open_api_spec_string).with_indifferent_access 
+        @read_openapi_spec ||= JSON.parse(@open_api_spec_string).with_indifferent_access
       end
-  
     end
   end
-end
+end

data/lib/mobile_workflow/railtie.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'mobile_workflow'
 require 'rails'
 
@@ -10,4 +12,4 @@ module MobileWorkflow
       Dir.glob("#{path}/tasks/**/*.rake").each { |f| load f }
     end
   end
-end
+end

data/lib/mobile_workflow/tasks/s3.rake

@@ -1,4 +1,6 @@
-desc "Add S3 storage to a Heroku app"
+# frozen_string_literal: true
+
+desc 'Add S3 storage to a Heroku app'
 namespace :mw do
   task add_heroku_s3_storage: :environment do
     require 'mobile_workflow/cli'
@@ -6,7 +8,7 @@ namespace :mw do
     aws_region = ENV['AWS_REGION'] || 'us-east-1'
     aws = MobileWorkflow::Cli::AwsBackend.new(app_name: app_name, region: aws_region)
     heroku = MobileWorkflow::Cli::HerokuBackend.new(app_name: app_name)
-    aws.create
+    aws.create!
     aws.create_topic_subscription(heroku.notifications_endpoint)
   end
-end
+end

data/lib/mobile_workflow/tasks/set_env.rake

@@ -1,61 +1,60 @@
+# frozen_string_literal: true
+
 require 'json'
 
-def each_step(json, type)
-  json['workflows'].map{|w| w["steps"].select {|s| s["type"] == type.to_s}}.flatten.each do |step|
-    yield(step)
-  end
+def each_step(json, type, &block)
+  json['workflows'].map { |w| w['steps'].select { |s| s['type'] == type.to_s } }.flatten.each(&block)
 end
 
 def replace_oauth(app_json)
-  client_id = ENV["CLIENT_ID"]
-  client_secret = ENV["CLIENT_SECRET"]
-  redirect_scheme = ENV["SCHEME"]
-  
+  client_id = ENV['CLIENT_ID']
+  client_secret = ENV['CLIENT_SECRET']
+  redirect_scheme = ENV['SCHEME']
+
   each_step(app_json, :networkOAuth2) do |step|
-    step["items"].each do |item|
-      if item["oAuth2ClientId"]
-        item["oAuth2ClientId"] = client_id
-        item["oAuth2ClientSecret"] = client_secret
-        item["oAuth2RedirectScheme"] = redirect_scheme
-      end      
+    step['items'].each do |item|
+      next unless item['oAuth2ClientId']
+
+      item['oAuth2ClientId'] = client_id
+      item['oAuth2ClientSecret'] = client_secret
+      item['oAuth2RedirectScheme'] = redirect_scheme
     end
-  end  
+  end
 end
 
 def replace_servers(app_json)
-  server_url = ENV["SERVER_URL"]
-  base_url = ENV["PREVIOUS_SERVER_URL"]
-  
-  app_json["servers"].each do |server|
-    server["url"] = server_url
+  server_url = ENV['SERVER_URL']
+  base_url = ENV['PREVIOUS_SERVER_URL']
+
+  app_json['servers'].each do |server|
+    server['url'] = server_url
   end
 
   each_step(app_json, :display) do |step|
-    step["items"].each do |item|
-      ["appleSystemURL", "androidDeepLink"].each{|key| item[key] = item[key].gsub(base_url, server_url) }
+    step['items'].each do |item|
+      %w[appleSystemURL androidDeepLink].each { |key| item[key] = item[key].gsub(base_url, server_url) }
     end
   end
 end
 
-def env_set(path)
+def env_set(_path)
   app_json = JSON.parse(File.read(app_json_path))
   replace_oauth(app_json)
   replace_servers(app_json)
-  File.write(app_json_path, app_json.to_json)  
+  File.write(app_json_path, app_json.to_json)
 end
 
 namespace :mw do
   namespace :set_env do
     desc 'Update Android app.json to use new env'
-    task :android do
+    task android: :environment do
       env_set(File.join('app', 'src', 'main', 'res', 'raw', 'app.json'))
     end
-  
+
     desc 'Update iOS app.json to use new env'
-    task :ios do
-      project_name = ENV["PROJECT_NAME"]
-      env_set(File.join(project_name, project_name, "Resources", "app.json"))
+    task ios: :environment do
+      project_name = ENV['PROJECT_NAME']
+      env_set(File.join(project_name, project_name, 'Resources', 'app.json'))
     end
-  end  
+  end
 end
-

data/lib/mobile_workflow/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module MobileWorkflow
-  VERSION = '0.10.2'
+  VERSION = '0.12.0'
   RUBY_VERSION = '2.7.3'
   RAILS_VERSION = '6.1.3.1'
 end

data/lib/mobile_workflow.rb

@@ -1,5 +1,7 @@
-require "mobile_workflow/engine"
-require "mobile_workflow/displayable"
+# frozen_string_literal: true
+
+require 'mobile_workflow/deprecated'
+require 'mobile_workflow/engine'
 
 module MobileWorkflow
   require 'mobile_workflow/railtie' if defined?(Rails)

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: mobile_workflow
 version: !ruby/object:Gem::Version
-  version: 0.10.2
+  version: 0.12.0
 platform: ruby
 authors:
 - Matt Brooke-Smith
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-14 00:00:00.000000000 Z
+date: 2022-08-19 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: app_rail-steps
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.5
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3
   requirement: !ruby/object:Gem::Requirement
@@ -65,21 +79,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '7'
 - !ruby/object:Gem::Dependency
-  name: app_rail-steps
-  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: sqlite3
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -93,7 +93,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
+  name: generator_spec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -107,7 +107,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: generator_spec
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -121,7 +121,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -159,7 +159,6 @@ files:
 - app/models/concerns/mobile_workflow/displayable/steps/form.rb
 - app/models/concerns/mobile_workflow/displayable/steps/list.rb
 - app/models/concerns/mobile_workflow/displayable/steps/map.rb
-- app/models/concerns/mobile_workflow/displayable/steps/pie_chart.rb
 - app/models/concerns/mobile_workflow/displayable/steps/question.rb
 - app/models/concerns/mobile_workflow/displayable/steps/stack.rb
 - app/models/concerns/mobile_workflow/displayable/steps/styled_content/grid.rb
@@ -201,7 +200,7 @@ files:
 - lib/mobile_workflow/cli/aws_backend.rb
 - lib/mobile_workflow/cli/dokku_backend.rb
 - lib/mobile_workflow/cli/heroku_backend.rb
-- lib/mobile_workflow/displayable.rb
+- lib/mobile_workflow/deprecated.rb
 - lib/mobile_workflow/engine.rb
 - lib/mobile_workflow/open_api_spec/parser.rb
 - lib/mobile_workflow/railtie.rb
@@ -227,7 +226,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: A Rails engine to provide API support for Mobile Workflow Apps.

data/app/models/concerns/mobile_workflow/displayable/steps/pie_chart.rb

@@ -1,11 +0,0 @@
-module MobileWorkflow
-  module Displayable
-    module Steps
-      module PieChart
-        def mw_pie_chart_item(id: self.id, label:, value:)
-          {id: id, label: label, value: value}.compact
-        end
-      end
-    end
-  end
-end

data/lib/mobile_workflow/displayable.rb

@@ -1,9 +0,0 @@
-require_relative '../../app/models/concerns/mobile_workflow/displayable/steps/styled_content/grid.rb'
-require_relative '../../app/models/concerns/mobile_workflow/displayable/steps/styled_content/stack.rb'
-require_relative '../../app/models/concerns/mobile_workflow/displayable/steps/form.rb'
-require_relative '../../app/models/concerns/mobile_workflow/displayable/steps/list.rb'
-require_relative '../../app/models/concerns/mobile_workflow/displayable/steps/map.rb'
-require_relative '../../app/models/concerns/mobile_workflow/displayable/steps/pie_chart.rb'
-require_relative '../../app/models/concerns/mobile_workflow/displayable/steps/question.rb'
-require_relative '../../app/models/concerns/mobile_workflow/displayable/steps/stack.rb'
-require_relative '../../app/models/concerns/mobile_workflow/displayable.rb'