forced 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c1b62f3102ad7c3f39bfb99d9b7ea2cec3873f29
-  data.tar.gz: cabafaba97d16fc8191b4971bb972684ca887cc8
+  metadata.gz: 24410ac9c0767e607034525d8168837dc87231bf
+  data.tar.gz: 1706c0b98edca3bc8b4e09779c829fdc74c07180
 SHA512:
-  metadata.gz: f5716bc3e260313d6db7d072a917fad99fd7ecd2f1c0578ae6fcf03eb9a88de8428d1c522b0cc30432517a08b0cfc1b5371513526b4533e071c1f1ee25c49255
-  data.tar.gz: 8dd67dc2a93046387c8de356db7038e512533755ec9498e6d01c456862dfbabfd2cd1c29d8ec9058379e4ec2510e13efaa00f4723b66f4cacc27f2223c6724d1
+  metadata.gz: 16f9039bfcd3f53f2a91148d28f3c52f8363e2c735eca9e3d76ff9d2c4ca7ae5d2495313e6280d5e7eeb91ba39eb7f03525ba516158daecba4a9e2d723e25a49
+  data.tar.gz: 49b535a85af7581037e7db44d8dceaba655db7454e17a38f70c1f074cd0c7d61161d5a422f7540d78648dad963ba260f35411b68bc74cc125c84e4b75024fa10

data/README.md

@@ -6,16 +6,45 @@ Read the link below to get some insight.
 
 * [Handling Force Update on Mobile Apps / Rusty Neuron](https://rustyneuron.net/2018/07/12/handling-force-update-on-mobile-apps/)
 
-## Usage
+## Installation
+Add this line to your application's Gemfile:
 
-Module needs to get the coming request to prepare the response. As long as request headers contains `X-Platform` and `X-Client-Version`, you are good to go.
+```ruby
+gem 'forced'
+```
+
+And then execute:
+```bash
+$ bundle
+```
 
-After adding `forced` to your Gemfile, add the line below to your routes file.
+Or install it yourself as:
+```bash
+$ gem install forced
+```
+
+And then, run:
+```bash
+# this will create a migration file.
+$ bundle exec rails g forced:install
+
+# this will migrate it.
+$ bundle exec rails db:migrate
+```
+
+After all these are done, add the line below to your routes file.
 
 ```ruby
 mount Forced::Engine => "/forced"
 ```
 
+You are all set!
+
+## Usage
+
+Module needs to get the coming request to prepare the response. As long as request headers contains `X-Platform` and `X-Client-Version`, you are good to go.
+
+
 Then send a `GET` request to `{{url}}/forced/status`. This will return the below JSON.
 
 ```json
@@ -52,22 +81,5 @@ Forced::AppVersion.new
 
 All available under `Forced::MESSAGES` hash table. You can override the values as you wish. Also checkout the `check_update_status` private method in `base.rb` to understand the cases.
 
-## Installation
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'forced'
-```
-
-And then execute:
-```bash
-$ bundle
-```
-
-Or install it yourself as:
-```bash
-$ gem install forced
-```
-
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/forced/engine.rb

@@ -1,14 +1,5 @@
 module Forced
   class Engine < ::Rails::Engine
     isolate_namespace Forced
-
-    # import engine's migratons into main app
-    initializer :append_migrations do |app|
-      unless app.root.to_s.match root.to_s
-        config.paths["db/migrate"].expanded.each do |expanded_path|
-          app.config.paths["db/migrate"] << expanded_path
-        end
-      end
-    end
   end
 end

data/lib/forced/version.rb

@@ -1,6 +1,6 @@
 module Forced
   MAJOR = 0
-  MINOR = 1
+  MINOR = 2
   TINY  = 0
   PRE   = nil
 

data/lib/generators/forced/install_generator.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require 'rails/generators/active_record'
+
+module Forced
+  class InstallGenerator < ::Rails::Generators::Base
+    include ::Rails::Generators::Migration
+
+    MYSQL_ADAPTERS = [
+      "ActiveRecord::ConnectionAdapters::MysqlAdapter",
+      "ActiveRecord::ConnectionAdapters::Mysql2Adapter"
+    ].freeze
+
+    source_root File.expand_path('templates', __dir__)
+
+    desc "Generates (but does not run) a migration to add a forced_app_versions table."
+
+    def create_migration_file
+      add_paper_trail_migration('create_forced_app_versions')
+    end
+
+    def self.next_migration_number(dirname)
+      ::ActiveRecord::Generators::Base.next_migration_number(dirname)
+    end
+
+    protected
+
+    def add_paper_trail_migration(template)
+      migration_dir = File.expand_path('db/migrate')
+
+      if self.class.migration_exists?(migration_dir, template)
+        ::Kernel.warn "Migration already exists: #{template}"
+      else
+        migration_template(
+          "#{template}.rb.erb",
+          "db/migrate/#{template}.rb",
+          migration_version: migration_version,
+          forced_app_versions_table_options: forced_app_versions_table_options
+        )
+      end
+    end
+
+    private
+
+    def migration_version
+      major = ActiveRecord::VERSION::MAJOR
+      if major >= 5
+        "[#{major}.#{ActiveRecord::VERSION::MINOR}]"
+      end
+    end
+
+    def mysql?
+      MYSQL_ADAPTERS.include?(ActiveRecord::Base.connection.class.name)
+    end
+
+    def forced_app_versions_table_options
+      if mysql?
+        ', { options: "ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_general_ci" }'
+      else
+        ""
+      end
+    end
+  end
+end

data/lib/generators/forced/templates/create_forced_app_versions.rb.erb

@@ -0,0 +1,15 @@
+# This migration creates the `app_versions` table, the only schema PT requires.
+# All other migrations PT provides are optional.
+class CreateForcedAppVersions < ActiveRecord::Migration<%= migration_version %>
+
+  def change
+    create_table :forced_app_versions<%= forced_app_versions_table_options %> do |t|
+      t.integer :client
+      t.string :version, limit: 255
+      t.boolean :force_update, nil: false, default: false
+      t.text :changelog
+
+      t.timestamps
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: forced
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - aoozdemir
@@ -62,19 +62,11 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- app/assets/config/forced_manifest.js
-- app/assets/javascripts/forced/application.js
-- app/assets/stylesheets/forced/application.css
 - app/controllers/forced/application_controller.rb
 - app/controllers/forced/status_controller.rb
-- app/helpers/forced/application_helper.rb
-- app/jobs/forced/application_job.rb
-- app/mailers/forced/application_mailer.rb
 - app/models/forced/app_version.rb
 - app/models/forced/application_record.rb
-- app/views/layouts/forced/application.html.erb
 - config/routes.rb
-- db/migrate/20180713160038_create_forced_app_versions.rb
 - lib/forced.rb
 - lib/forced/base.rb
 - lib/forced/client_enum.rb
@@ -82,6 +74,8 @@ files:
 - lib/forced/messages.rb
 - lib/forced/response.rb
 - lib/forced/version.rb
+- lib/generators/forced/install_generator.rb
+- lib/generators/forced/templates/create_forced_app_versions.rb.erb
 - lib/tasks/forced_tasks.rake
 homepage: https://github.com/aoozdemir/forced
 licenses:

data/app/assets/config/forced_manifest.js

@@ -1,2 +0,0 @@
-//= link_directory ../javascripts/forced .js
-//= link_directory ../stylesheets/forced .css

data/app/assets/javascripts/forced/application.js

@@ -1,15 +0,0 @@
-// This is a manifest file that'll be compiled into application.js, which will include all the files
-// listed below.
-//
-// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
-// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
-//
-// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
-// compiled file. JavaScript code in this file should be added after the last require_* statement.
-//
-// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
-// about supported directives.
-//
-//= require rails-ujs
-//= require activestorage
-//= require_tree .

data/app/assets/stylesheets/forced/application.css

@@ -1,15 +0,0 @@
-/*
- * This is a manifest file that'll be compiled into application.css, which will include all the files
- * listed below.
- *
- * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
- * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
- *
- * You're free to add application-wide styles to this file and they'll appear at the bottom of the
- * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
- * files in this directory. Styles in this file should be added after the last require_* statement.
- * It is generally better to create a new file per style scope.
- *
- *= require_tree .
- *= require_self
- */

data/app/helpers/forced/application_helper.rb

@@ -1,4 +0,0 @@
-module Forced
-  module ApplicationHelper
-  end
-end

data/app/jobs/forced/application_job.rb

@@ -1,4 +0,0 @@
-module Forced
-  class ApplicationJob < ActiveJob::Base
-  end
-end

data/app/mailers/forced/application_mailer.rb

@@ -1,6 +0,0 @@
-module Forced
-  class ApplicationMailer < ActionMailer::Base
-    default from: 'from@example.com'
-    layout 'mailer'
-  end
-end

data/app/views/layouts/forced/application.html.erb

@@ -1,16 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <title>Forced</title>
-  <%= csrf_meta_tags %>
-  <%= csp_meta_tag %>
-
-  <%= stylesheet_link_tag    "forced/application", media: "all" %>
-  <%= javascript_include_tag "forced/application" %>
-</head>
-<body>
-
-<%= yield %>
-
-</body>
-</html>

data/db/migrate/20180713160038_create_forced_app_versions.rb

@@ -1,12 +0,0 @@
-class CreateForcedAppVersions < ActiveRecord::Migration[5.2]
-  def change
-    create_table :forced_app_versions do |t|
-      t.integer :client
-      t.string :version, limit: 255
-      t.boolean :force_update, nil: false, default: false
-      t.text :changelog
-
-      t.timestamps
-    end
-  end
-end