airslie-engineer 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3845ee121169c0e4368a5f9b718ea104d35e1089891867f044514641b21746ba
+  data.tar.gz: a7cf566c986b3ba47595144d12748738d386ab8d93bd20ad87c1195fa3cf5337
+SHA512:
+  metadata.gz: 580a40b11805629f416007b1045d18314fc1b26c3707558c87d551531a200345148bc823e55dfb093f48668e2f83877084d909f31e99d3c74ad81879fec91a9f
+  data.tar.gz: 2736a5837435728a4267619d86c545147be3269dec5a8d24469103f205931d0198483b70bccf64e676e586facf8bfc08da9eb18ec12874aa482a8405cd715813

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Airslie Ltd
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,46 @@
+[![Maintainability](https://api.codeclimate.com/v1/badges/112e9f4a7cda28bd73d7/maintainability)](https://codeclimate.com/github/airslie/engineer/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/112e9f4a7cda28bd73d7/test_coverage)](https://codeclimate.com/github/airslie/engineer/test_coverage)
+
+# Engineer
+
+This gem makes developing a Renalware plugin (a Rails engine) a little easier.
+It does most of the standard Engine initialization including:
+
+- appending the engine's `db/migrate`, `db/triggers`, `db/functions` and `db/views` paths to the
+  application's `config.paths` so that migrations across all engines and the app itself - and any
+  sql definition files referenced in migrations - can be found during a `db:migrate`
+- loading any `config/locale/**/*.yml` that exist in the engine.
+- more to follow..
+
+## Usage
+
+In your Rails engine add the following to `lib/xxxx/engine.rb`:
+
+```ruby
+  class Engine < ::Rails::Engine
+    isolate_namespace Renalware::Xxxx
+    include Engineer::DefaultInitializers
+    ...
+  end
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'engineer'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+# Development Tasks
+
+- [ ] Add tests
+- [ ] Add a generator to bring in standard files for a new Renalware plugin
+- [ ] Look for other Engine boiler-plate code we can move here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+require "rdoc/task"
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title    = "Engineer"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.md")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end
+
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = false
+end
+
+task default: :test

data/lib/engineer.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "engineer/railtie"
+require "engineer/database/scenic"
+require "engineer/database/initializers"
+require "engineer/locale/initializers"
+require "engineer/default_initializers"
+require "engineer/seed_extensions"
+
+module Engineer
+end

data/lib/engineer/database/append_engine_paths.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Engineer
+  module Database
+    #
+    #  Add db/migrate, db/views, db/triggers and db/functions folders to app.config.paths so they
+    # can be resolved during migration
+    # Be sure sure to append to any existing entries in #paths, because other engines, and
+    # the app itself, will add their paths too.
+    # This step is especially important for the Scenic gem; sql view definitions in db/views
+    # are referenced by filename from migrations, and we need to be able to locate those files.
+    # The Scenic issue is a bit more too it see scenic.rb for more info.
+    # Note that a common but way more kludgy approach to this problem is to copy the migrations
+    # views etc from each gen into the host app with a rake task. This is a slicker a less
+    # error-proone solution.
+    #
+    class AppendEnginePaths
+      attr_reader :app, :engine_config
+
+      def initialize(app:, engine_config:)
+        @app = app
+        @engine_config = engine_config
+      end
+
+      def call
+        append_migration_paths
+        append_other_paths
+      end
+
+      # db/migrate paths are handled rather differently.
+      # Prevent duplicate migrations if we are db:migrating at the engine level (eg when
+      # running tests) rather than the host app.
+      def append_migration_paths
+        if running_in_dummy_app? || running_outside_of_engine?
+          add_engine_db_path_to_app("migrate")
+        end
+      end
+
+      def append_other_paths
+        %w(views functions triggers).each do |sub_folder|
+          add_engine_db_path_to_app(sub_folder)
+        end
+      end
+
+      def add_engine_db_path_to_app(sub_folder)
+        key = "db/#{sub_folder}"
+        path_to_db_things_in_engine = Rails.root.join(engine_config.root, "db", sub_folder)
+        app_config = app.config
+        app_config.paths[key] ||= []
+        app_config.paths[key] << path_to_db_things_in_engine
+      end
+
+      def running_in_dummy_app?
+        Dir.pwd.ends_with?("dummy")
+      end
+
+      def running_outside_of_engine?
+        app.root.to_s.match(engine_config.root.to_s + File::SEPARATOR).nil?
+      end
+    end
+  end
+end

data/lib/engineer/database/initializers.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative "./append_engine_paths"
+
+module Engineer
+  module Database
+    class Initializers
+      attr_reader :klass
+
+      def initialize(klass)
+        @klass = klass
+      end
+
+      def add
+        klass.initializer :"append_migrations_in_#{klass.name.underscore.tr("/", "_")}" do |app|
+          AppendEnginePaths.new(app: app, engine_config: config).call
+        end
+      end
+    end
+  end
+end

data/lib/engineer/database/scenic.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Engineer
+  module Database
+    # The scenic gem supports loading SQL view definition files from a db/views folder but only
+    # supports one folder (it looks in app.config.paths["db/views"] and takes the last one) which
+    # works fine if you are using a rake task to copy all your views from various engines into the
+    # host app. But this a bit issues prone and it is much nicer to add each engine's db/views
+    # folder to app.config.paths (we do this in the Engineer::Database::Initializers class provided
+    # the engine includes the appropriate file) and then here we override the Scenic
+    # Definition#to_sql method and when a view definition file is requested, search all db/views
+    # paths - which may search in several engines and host app itself - and hopefully find the file
+    # we are looking for. In theory that file should be in the same engine/app that its
+    # corresponding migration is in... though we can't verify that and its unlikely
+    # We raise an error if we find two matching files i.e. a view definition file of the same name
+    # in two gems.
+    module ResolveScenicViewsAnywhere
+      def to_sql
+        view_definition_file = find_view_definition_among_all_possible_paths
+
+        File.read(view_definition_file).tap do |content|
+          if content.empty?
+            raise "Define view query in #{path} before migrating."
+          end
+        end
+      end
+
+      def find_view_definition_among_all_possible_paths
+        found_files = all_full_paths.select{ |path| File.exist?(path) }
+        if found_files.length > 1
+          raise "More than one view definition matches the name #{filename}\n #{found_files}"
+        end
+
+        found_files.first
+      end
+
+      def all_full_paths
+        app = Rails.application
+        return super unless defined?(app) && app.present?
+
+        app.config.paths["db/views"].map { |path| File.join(path, filename) }
+      end
+    end
+
+    if defined?(Scenic)
+      Scenic::Definition.send(:prepend, ResolveScenicViewsAnywhere)
+    end
+  end
+end

data/lib/engineer/database/seed_helper.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "csv"
+
+module Engineer
+  module Database
+    module SeedHelper
+      def log(msg, type: :full)
+        case type
+        when :full
+          print "-----> #{msg}"
+          if block_given?
+            ms = Benchmark.ms { yield }
+            milliseconds = "#{ms.to_i}ms"
+            print "\r-----> #{milliseconds.ljust(8, ' ')} #{msg}"
+          end
+          print "\n"
+        when :sub
+          puts "                #{msg}"
+        else
+          raise "Unknown type #{type}"
+        end
+      end
+
+      def log_section(title)
+        log "-" * 80
+        log title
+        log "-" * 80
+      end
+
+      def without_papertrail_versioning_for(klass)
+        raise ArgumentError unless klass.is_a? Class
+        klass.paper_trail.disable
+        yield
+        klass.paper_trail.enable
+      end
+    end
+  end
+end

data/lib/engineer/default_initializers.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Engineer
+  module DefaultInitializers
+    def self.included(klass)
+      Database::Initializers.new(klass).add
+      Locale::Initializers.new(klass).add
+    end
+  end
+end

data/lib/engineer/locale/initializers.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+#
+# Add an initializer to pull in the Engine's locale yml files.
+#
+module Engineer
+  module Locale
+    class Initializers
+      def initialize(klass)
+        @klass = klass
+      end
+
+      def add
+        klass.initializer :"add_locals_in_#{klass.name.underscore.tr("/", "_")}" do |app|
+          # Because we have a different binding here we can't call private Initializers
+          # members so instead explicitly call a class method on ourselves passing in the
+          # variables we need.
+          Engineer::Locale::Initializers.add_engine_locale_files(app, config)
+        end
+      end
+
+      def self.add_engine_locale_files(app, engine_config)
+        engine_locale_files = Dir[engine_config.root.join("config", "locales", "**", "*.{rb,yml}")]
+        i18n = app.config.i18n
+        i18n.load_path += engine_locale_files
+        i18n.default_locale = "en-GB"
+        i18n.fallbacks = [:en]
+      end
+
+      private
+
+      attr_reader :klass
+    end
+  end
+end

data/lib/engineer/railtie.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Engineer
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/engineer/seed_extensions.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Engineer
+  module SeedExtensions
+    def load_demo_seed
+      require root.join("demo_data/seeds")
+    end
+  end
+end
+
+Rails::Engine.prepend(Engineer::SeedExtensions)

data/lib/engineer/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Engineer
+  VERSION = "1.0.0"
+end

data/lib/tasks/engineer_tasks.rake

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# desc "Explaining what the task does"
+# task :engineer do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: airslie-engineer
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Airslie Ltd
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-02-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.2
+description: Making Renalware plugin development easier
+email:
+- dev@airslie.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/engineer.rb
+- lib/engineer/database/append_engine_paths.rb
+- lib/engineer/database/initializers.rb
+- lib/engineer/database/scenic.rb
+- lib/engineer/database/seed_helper.rb
+- lib/engineer/default_initializers.rb
+- lib/engineer/locale/initializers.rb
+- lib/engineer/railtie.rb
+- lib/engineer/seed_extensions.rb
+- lib/engineer/version.rb
+- lib/tasks/engineer_tasks.rake
+homepage: https://github.com/airslie/engineer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Making Renalware plugin development easier
+test_files: []