modulorails 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7a96938b07505567d256c051a9de1c495e145d2a3b5e8e0e90fbbb5e0eb0376
-  data.tar.gz: 3f11b735571b42d431ee155a3fd7169d6bf2b8eb40b88042ab7d98d5f9636119
+  metadata.gz: 92b2390033b3083f0829661ac44665f58f8eb438fb095d32c803ae5cea51c488
+  data.tar.gz: 5e13ccdb0a64f7b32ac594601f4f2415f081a16284e9c73cb1953c3e5cc47497
 SHA512:
-  metadata.gz: 26076299430329d25d6137e293e4c7ba5d3577269358f59070b9f32dec7b8ea033be1c5c9f2d0016227d26c12d685124060f3188afb77318b7320e3acdcb0a36
-  data.tar.gz: 13d8bef4d1847342bdbf286546252bb570b96d3120f0d492170a19eff0d8aea25318e73583b69f695e3e8fa221ddce831399a5b70dad634254b5d47c302e35cc
+  metadata.gz: 1e9e8885a9c648e7de6af49c3fa66ab59243714eda2449cd8398f4c09efa2fa5f744d71db7aa68f91a8f9912282c416e6e91f8c665b1035ea376974702251924
+  data.tar.gz: c15837070582d0a901fdfeee1c1d0be86a67f5fe69efbcca39fb14921e2ee1c527dadca48ab0c89691679d8bcc9144586a2ab4309773b4a8e8771369cb8ef5c7

data/CHANGELOG.md

@@ -1 +1,17 @@
 #  CHANGELOG
+
+This file is used to list changes made in each version of the gem.
+
+# 0.2.0
+
+Auto-update release.
+
+- Add auto-update feature.
+
+# 0.1.0
+
+Initial release.
+
+- Send configuration to intranet.
+- Write CI/CD templates.
+- Check database configuration.

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    modulorails (0.1.0)
+    modulorails (0.2.0)
       git (~> 1.7, >= 1.7.0)
       httparty
+      i18n
       railties (>= 4.2.0)
 
 GEM

data/config/locales/en.yml

@@ -0,0 +1,16 @@
+en:
+  modulorails:
+    standard_config_file_location: The database configuration file can not be found at config/database.yml
+    test_database_not_equals_dev_database: The test database is equal to the development database
+    development:
+      configurable_host: Host is not configurable for development environment
+      configurable_username: Username is not configurable for development environment
+      configurable_password: Password is not configurable for development environment
+      configurable_database: Database name is not configurable for development environment
+      configurable_port: Port is not configurable for development environment
+    test:
+      configurable_host: Host is not configurable for test environment
+      configurable_username: Username is not configurable for test environment
+      configurable_password: Password is not configurable for test environment
+      configurable_database: Database name is not configurable for test environment
+      configurable_port: Port is not configurable for test environment

data/lib/generators/gitlabci_generator.rb

@@ -124,7 +124,7 @@ class GitlabciGenerator < Rails::Generators::Base
     file = '.modulorails-gitlab-ci'
 
     # Create file to avoid this generator on next modulorails launch
-    create_file(file)
+    copy_file(file, file)
 
     say "Add #{file} to git"
     %x(git add #{file})

data/lib/generators/templates/.modulorails-gitlab-ci

@@ -0,0 +1,3 @@
+This file ensures the modulorails gem will not try to override your current .gitlab-ci.yml file.
+
+You can remove this file if you want the generator to rewrite your .gitlab-ci.yml file.

data/lib/modulorails.rb

@@ -2,6 +2,7 @@ require 'modulorails/version'
 require 'modulorails/configuration'
 require 'modulorails/data'
 require 'modulorails/validators/database_configuration'
+require 'modulorails/updater'
 require 'modulorails/railtie' if defined?(Rails::Railtie)
 require 'generators/gitlabci_generator'
 require 'httparty'
@@ -115,12 +116,23 @@ module Modulorails
       invalid_rules = Modulorails::Validators::DatabaseConfiguration.call
       return true if invalid_rules.empty?
 
-      puts('[Modulorails] The database configuration (config/database.yml) has errors:')
+      puts('[Modulorails] The database configuration (config/database.yml) has warnings:')
       invalid_rules.each do |rule|
-        puts("[Modulorails]    Invalid database configuration for rule: #{rule}")
+        t_rule = I18n.t(rule, scope: :modulorails, locale: :en)
+        puts("[Modulorails]    Invalid database configuration: #{t_rule}")
       end
 
       false
     end
+
+    # @author Matthieu 'ciappa_m' Ciappara
+    #
+    # Check the last version of Modulorails available on rubygems and update if there was a
+    # publication
+    def self_update
+      Modulorails::Updater.call unless configuration.no_auto_update
+    rescue StandardError => e
+      puts("[Modulorails] An error occured: #{e.class} - #{e.message}")
+    end
   end
 end

data/lib/modulorails/configuration.rb

@@ -3,7 +3,8 @@ module Modulorails
   # The configuration of the gem
   class Configuration
     # All the keys to configure the gem
-    attr_accessor :_name, :_main_developer, :_project_manager, :_endpoint, :_api_key
+    attr_accessor :_name, :_main_developer, :_project_manager, :_endpoint, :_api_key,
+                  :_no_auto_update
 
     # This allows to define a DSL to configure the gem
     # Example:
@@ -14,7 +15,7 @@ module Modulorails
     #   config.endpoint "intranet's endpoint"
     #   config.api_key "intranet's api key"
     # end
-    %i[name main_developer project_manager endpoint api_key].each do |field|
+    %i[name main_developer project_manager endpoint api_key no_auto_update].each do |field|
       define_method(field) do |value=nil|
         # No value means we want to get the field
         return send("_#{field}") unless value

data/lib/modulorails/data.rb

@@ -20,7 +20,12 @@ module Modulorails
       # Get the gem's configuration to get the application's usual name, main dev and PM
       configuration = Modulorails.configuration
       # Get the database connection to identify the database used by the application
-      db_connection = ActiveRecord::Base.connection
+      # or return nil if the database does not exist
+      db_connection = begin
+                        ActiveRecord::Base.connection
+                      rescue ActiveRecord::NoDatabaseError
+                        nil
+                      end
       # Get the gem's specifications to fetch the versions of critical gems
       loaded_specs = Gem.loaded_specs
 
@@ -64,7 +69,7 @@ module Modulorails
 
       # The version of the database engine; this request works only on MySQL and PostgreSQL
       # It should not be a problem since those are the sole database engines used at Modulotech
-      @db_version  = db_connection.select_value('SELECT version()')
+      @db_version = db_connection&.select_value('SELECT version()')
 
       # The version of the ActiveRecord adapter
       @adapter_version = loaded_specs[@adapter]&.version&.version

data/lib/modulorails/railtie.rb

@@ -5,6 +5,9 @@ module Modulorails
     config.after_initialize do
       # For now, we limit everything to the development environment
       if Rails.env.development?
+        # Load translations
+        I18n.load_path += [File.expand_path('../../../config/locales/en.yml', __FILE__)]
+
         # Effectively send the data to the intranet
         Modulorails.send_data
 
@@ -13,6 +16,9 @@ module Modulorails
 
         # Check database configuration
         Modulorails.check_database_config
+
+        # Gem's self-update if a new version was released
+        Modulorails.self_update
       end
     end
   end

data/lib/modulorails/updater.rb

@@ -0,0 +1,42 @@
+module Modulorails
+  # Author: Matthieu 'ciappa_m' Ciappara
+  # This updates modulorails by editing the gemfile and running a bundle update
+  class Updater
+    LATEST_VERSION_URL = 'https://rubygems.org/api/v1/versions/modulorails/latest.json'.freeze
+
+    def self.call(*args)
+      new(*args).call
+    end
+
+    def call
+      # Get the last published version
+      @last_published_version = HTTParty.get(LATEST_VERSION_URL).parsed_response['version']
+
+      # Do nothing if we could not fetch the last published version (whatever the reason)
+      # Or if the current version is the same as the last published version
+      return if @last_published_version.nil? || @last_published_version == Modulorails::VERSION
+
+      # If the last published version is different from the current version, we update the gem
+      edit_gemfile
+    end
+
+    private
+
+    def edit_gemfile
+      # Read the lines of the Gemfile
+      gemfile_location = Rails.root.join('Gemfile')
+      lines = File.readlines gemfile_location
+
+      # Search and replace the modulorails line
+      index = lines.index { |l| l =~ /gem\s['"]modulorails['"]/ }
+      lines[index].gsub!(/(\s*)gem\s['"]modulorails['"].*/,
+                         "#{$1}gem 'modulorails', '= #{@last_published_version}'")
+
+      # Update the Gemfile
+      File.open(gemfile_location, 'w') { |f| f.puts(lines) }
+
+      # Update the gem
+      `bundle install || bundle update modulorails`
+    end
+  end
+end

data/lib/modulorails/version.rb

@@ -1,3 +1,3 @@
 module Modulorails
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/modulorails.gemspec

@@ -32,6 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'railties', '>= 4.2.0'
   spec.add_runtime_dependency 'git', '~> 1.7', '>= 1.7.0'
   spec.add_runtime_dependency 'httparty'
+  spec.add_runtime_dependency 'i18n'
 
   spec.add_development_dependency 'activerecord', '>= 4.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: modulorails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Matthieu Ciappara
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-12 00:00:00.000000000 Z
+date: 2020-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -58,6 +58,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  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: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -96,13 +110,16 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- config/locales/en.yml
 - lib/generators/gitlabci_generator.rb
 - lib/generators/templates/.gitlab-ci.yml
+- lib/generators/templates/.modulorails-gitlab-ci
 - lib/generators/templates/config/database-ci.yml
 - lib/modulorails.rb
 - lib/modulorails/configuration.rb
 - lib/modulorails/data.rb
 - lib/modulorails/railtie.rb
+- lib/modulorails/updater.rb
 - lib/modulorails/validators/database_configuration.rb
 - lib/modulorails/version.rb
 - modulorails.gemspec