scintilla 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b6e8fc9cfcb9971c82a90394104d367363f7e62873d78ef13d6e8b0694f09cf0
+  data.tar.gz: 0e9361a281b9c76a925a8aaea47a74b10329fec94690e71f416a7b78124aed7d
+SHA512:
+  metadata.gz: 924c10b4ca1f65502a00be12eee89b2401027ade9c456295fdc4bedbd093d73e8215381ce1887742deab83d8f002f0528e019c6c78150446c48de2487fd63eba
+  data.tar.gz: 22a9afa92d4fb5efde8551456a81f01520956ec38b7c459550f74d8e20545d4a5b64d583e804b42cdd48b6e11c9840f485e80ae2dc128cc94f88f763b6bdc5de

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 Andrea Schiavini
+
+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,56 @@
+# Scintilla
+
+`TL;DR`: Scintilla allows running one-time scripts in your Rails application, mimicking
+the behaviour of Rails migrations.
+
+It relies on an ActiveRecord model (`ScintillaScript`) to keep track of already ran
+scripts (consider it the equivalent of the `schema_migrations` table).
+
+It offers a rake task, `scintilla:run`, to run scripts. Integrating it with your
+deployment flow is up to you.
+
+## Usage
+
+### Generating a new Scintilla script
+
+`> rails g scintilla do_something_useful`
+
+This will create a timestamped file under `db/scintilla`, like
+`20200324_do_something_useful.rb`. You will need to edit this file and fill the
+`do_the_stuff` method with the code you want to run.
+
+### Running Scintilla scripts
+
+`> rails scintilla:run`
+
+This will, in turn:
+
+- check the script files under `db/scintilla`;
+- for each of them, check if it has already been ran (a `Scintilla::Script` record is
+  present on DB), and only require the ones that still need to be ran;
+- run the missing scintilla scripts, and create `Scintilla::Script` records on DB for each
+  of them.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'scintilla'
+```
+
+And then execute:
+
+```bash
+$ rails scintilla:install:migrations
+$ rails db:migrate
+```
+
+## Contributing
+
+Feel free to open issues and PRs, fork the project as you want ;)
+
+
+## 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,34 @@
+# 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    = 'Scintilla'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('test/dummy/Rakefile', __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+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/app/assets/config/scintilla_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/scintilla .css

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

@@ -0,0 +1,15 @@
+/*
+ * 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/controllers/scintilla/application_controller.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Scintilla
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/helpers/scintilla/application_helper.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Scintilla
+  module ApplicationHelper
+  end
+end

data/app/jobs/scintilla/application_job.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Scintilla
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/scintilla/application_mailer.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Scintilla
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/scintilla/application_record.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Scintilla
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/scintilla/scintilla_script.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Scintilla
+  class ScintillaScript < ApplicationRecord
+  end
+end

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

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Scintilla</title>
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+
+    <%= stylesheet_link_tag    "scintilla/application", media: "all" %>
+  </head>
+  <body>
+
+    <%= yield %>
+
+  </body>
+</html>

data/config/routes.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+Scintilla::Engine.routes.draw do
+end

data/db/migrate/20200323165014_create_scintilla_scintilla_scripts.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+class CreateScintillaScintillaScripts < ActiveRecord::Migration[6.0]
+  def change
+    create_table :scintilla_scintilla_scripts do |t|
+      t.string :filename
+      t.datetime :ran_at
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/scintilla/USAGE

@@ -0,0 +1,8 @@
+Description:
+    This generator creates a scintilla script under db/scintilla
+
+Example:
+    rails generate scintilla DoSomething
+
+    This will create:
+       db/scintilla/<timestamp>_do_something.rb

data/lib/generators/scintilla/scintilla_generator.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require 'fileutils'
+
+class ScintillaGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('templates', __dir__)
+
+  def create_scintilla_file
+    dir = Rails.root.join 'db', 'scintilla'
+    FileUtils.mkdir_p dir
+    file = Rails.root.join 'db', 'scintilla', "#{Time.zone.now.strftime('%Y%m%d')}_#{name.gsub(/\.rb$/, '').underscore}.rb"
+    copy_file 'empty_scintilla_script.erb', file
+
+    gsub_file file, 'KlassName', name.camelize
+  end
+end

data/lib/generators/scintilla/templates/empty_scintilla_script.erb

@@ -0,0 +1,9 @@
+class KlassName < Scintilla::Runnable
+  def initialize
+    @file_name = Scintilla::Runner.script_name(__FILE__, false)
+  end
+
+  def do_the_stuff
+    # put your logic here
+  end
+end

data/lib/scintilla.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'scintilla/engine'
+Dir[Scintilla::Engine.root + 'app/models/**/*.rb'].collect { |f| require f }
+
+require 'scintilla/runner'
+require 'scintilla/runnable'
+
+module Scintilla
+  # Your code goes here...
+end

data/lib/scintilla/engine.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Scintilla
+  class Engine < ::Rails::Engine
+    isolate_namespace Scintilla
+  end
+end

data/lib/scintilla/runnable.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Scintilla
+  class Runnable
+    attr_accessor :file_name
+
+    # Runs the script, unless already ran.
+    #
+    # @return [<Scintilla::ScintillaScript>] the created ScintillaScript on DB, only if
+    #         script has ran successfully.
+    #
+    def run
+      if ScintillaScript.exists?(filename: file_name)
+        puts "#{file_name} already ran, skipping..."
+      else
+        puts "Running #{file_name}..."
+        do_the_stuff
+        ScintillaScript.create(filename: file_name, ran_at: Time.zone.now)
+      end
+    end
+
+    def do_the_stuff
+      raise 'Implement this in every Scintilla::Runner subclass...'
+    end
+  end
+end

data/lib/scintilla/runner.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Scintilla
+  class Runner
+    def self.run
+      scripts.each(&:run)
+    end
+
+    # Get the list of scripts to be ran.
+    #
+    # @param [<Boolean>] conditional_require whether to only require
+    #        scripts that still haven't ran. Defaults to true.
+    #
+    # @return [<Array<Scintilla::Runnable>>] the list of Runnable objects
+    #         to be ran.
+    #
+    def self.scripts(conditional_require = true)
+      scripts = require_scripts(conditional_require)
+      scripts.sort.inject([]) do |scripts_to_run, filename|
+        klass = script_name(filename, true).camelize.constantize
+        scripts_to_run << klass.new
+      end
+    end
+
+    # Requires the scripts in the db/scintilla path, to allow loading
+    # them for execution.
+    #
+    # @param [<Boolean>] conditional_require whether to only require
+    #        scripts that still haven't ran. This is useful if
+    #        older scripts contain references to no longer present
+    #        classes, and to boost performances. Set it to false
+    #        for debugging purposes.
+    #
+    def self.require_scripts(conditional_require)
+      scripts = Dir[Rails.root.join('db', 'scintilla', '*.rb')]
+      if conditional_require
+        scripts.reject! { |f| ScintillaScript.exists?(filename: script_name(f, false)) }
+      end
+      scripts.each { |f| require f }
+    end
+    private_class_method :require_scripts
+
+    # Extract script_name from file_name, removing timestamp and optionally
+    # removing extension.
+    #
+    # @param [<String>] full_file_path the full file path, e.g. /a/b/c.rb
+    # @param [<Boolean>] without_extension remove extension from file name.
+    #                    Defaults to false
+    #
+    # @return [<String>] the script name, e.g. c.rb
+    #
+    def self.script_name(full_file_path, without_extension = false)
+      name = File.basename(full_file_path).gsub(/^\d+_/, '') # remove timestamp
+      name = name.gsub(/\.rb$/, '') if without_extension
+      name
+    end
+  end
+end

data/lib/scintilla/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Scintilla
+  VERSION = '0.1.0'
+end

data/lib/tasks/scintilla_tasks.rake

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+namespace :scintilla do
+  desc 'Run Scintilla scripts'
+  task run: :environment do
+    Scintilla::Runner.run
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: scintilla
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrea Schiavini
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-03-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Scintilla allows running scripts only once, mimicking the behaviour of
+  Rails migrations
+email:
+- metalelf0@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/scintilla_manifest.js
+- app/assets/stylesheets/scintilla/application.css
+- app/controllers/scintilla/application_controller.rb
+- app/helpers/scintilla/application_helper.rb
+- app/jobs/scintilla/application_job.rb
+- app/mailers/scintilla/application_mailer.rb
+- app/models/scintilla/application_record.rb
+- app/models/scintilla/scintilla_script.rb
+- app/views/layouts/scintilla/application.html.erb
+- config/routes.rb
+- db/migrate/20200323165014_create_scintilla_scintilla_scripts.rb
+- lib/generators/scintilla/USAGE
+- lib/generators/scintilla/scintilla_generator.rb
+- lib/generators/scintilla/templates/empty_scintilla_script.erb
+- lib/generators/scintilla/templates/empty_scintilla_script.erb.tmp
+- lib/scintilla.rb
+- lib/scintilla/engine.rb
+- lib/scintilla/runnable.rb
+- lib/scintilla/runner.rb
+- lib/scintilla/version.rb
+- lib/tasks/scintilla_tasks.rake
+homepage: https://github.com/metalelf0/scintilla
+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: Scintilla is a library for one-time scripts on Rails
+test_files: []