database_logic 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a6980677389882e319a1c4159b2954c31166402218d1485313e280a746458ddc
+  data.tar.gz: f482be43d5b8e545dc6fa66dee1cea114989eedc6ff4c7ec61ad7217aceb875b
+SHA512:
+  metadata.gz: 97c6e0e74c3f5cd8d4fb7bc4c08bc4a2babc638a380f08e2500306bb7ca96b39e76330a981075e3e2243a5e6c8729582bc2c23e1b080284e50d2374234b554c1
+  data.tar.gz: 9b575316c6b3b788d89dfbcbf194fab94bc0d5d18a248b514b3b5f357cbe841d3bcec2ef35ccb12da7b3ef47bf2acc16cbbefb0677129d5a231833059ffa55ba

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-06-19
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at TODO: Write your email address. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in database_logic.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 CheckThisOut
+
+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,170 @@
+# DatabaseLogic
+
+Yeah, yeah, database layer logic is a big no-no in the Rails community. But if you're building something serious, sooner or later you will need to break the rules. There are several gems out there that come up with different solutions, yet they are very opinionated and sometimes get in the way. This simple gem tries to solve these issues.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'database_logic'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install database_logic
+
+## Usage
+
+First, let's try creating a view. For this, we will need an User model, as follows:
+
+`rails g model User first_name:string last_name:string balance_in_cents:integer address:string city:string`
+
+this will generate:
+
+```ruby
+# app/db/migrate/20210619153721_create_users.rb
+class CreateUsers < ActiveRecord::Migration[6.0]
+  def change
+    create_table :users do |t|
+        t.string :first_name
+        t.string :last_name
+        t.integer :balance_in_cents
+        t.string :address
+        t.string :city
+        t.timestamps
+    end
+  end
+end
+```
+
+So far so good! Let's apply our changes:
+
+`rails db:migrate`
+
+Now let's assume we want a view that shows users' first name and last name merged into `full_name`, so we will use the view generator to create our first view file:
+
+`rails g database_logic:view users_full`
+
+This will generate:
+
+```
+# app/sql/views/20210519160509_users_full.sql
+# ... some default garbage from a template...
+```
+Let us edit this file, delete the gibberish and add our view SQL:
+
+```
+create or replace view [DB].users_full as
+ select concat(first_name, ' ', last_name) as full_name, balance_in_cents/100 as balance, concat(address, ' ', city) as full_address from [DB].users;
+```
+
+After saving the SQL file let's apply our changes:
+
+`rake database_logic:views:create`
+
+```
+MariaDB [app_dev]> describe users_full;
++--------------+---------------+------+-----+---------+-------+
+| Field        | Type          | Null | Key | Default | Extra |
++--------------+---------------+------+-----+---------+-------+
+| full_name    | varchar(511)  | YES  |     | NULL    |       |
+| balance      | decimal(14,4) | YES  |     | NULL    |       |
+| full_address | varchar(511)  | YES  |     | NULL    |       |
++--------------+---------------+------+-----+---------+-------+
+```
+
+So far so good! At this point we might not want to have to run a rake task after each addition/change, so we want to .enhance the db:migrate task as follows:
+
+```ruby
+# lib/tasks/dblogic.rake
+
+# on drop, drop SQL logic too
+Rake::Task["db:drop"].enhance ["database_logic:drop"]
+
+# on migration, re-create all SQL logic
+Rake::Task["db:migrate"].enhance do
+    Rake::Task["database_logic:recreate"].execute
+end
+```
+
+But in real life, users have Transactions, so let's also create a Transaction model, as follows:
+
+`rails g model Transaction user_id:integer amount_in_cents:integer kind:string`
+
+this will generate:
+
+```ruby
+# app/db/migrate/20210619153732_create_transactions.rb
+class CreateTransactions < ActiveRecord::Migration[6.0]
+  def change
+    create_table :transactions do |t|
+        t.integer :user_id
+        t.integer :amount_in_cents
+        t.string :kind
+      t.timestamps
+    end
+  end
+end
+```
+
+And now, let's say we want our "balance" column to update _on the database side_ whenever we add Transactions. Without bloating our models with AR hooks/callbacks, and without database inconsistencies caused by the delays that plague db to app communication, that is.
+
+First, we will create a trigger:
+
+`rails g database_logic:trigger after insert transactions`
+
+This will generate:
+```
+# app/sql/triggers/20213619173650_update_balance.sql
+# ... some default garbage from a template...
+```
+
+We want to edit this file and add our trigger SQL:
+```
+create trigger update_balance after insert on [DB].transactions
+for each row
+    begin
+        update users set balance_in_cents = balance_in_cents+NEW.amount_in_cents;
+    end;
+```
+
+Finally, let's migrate: `rake db:migrate`. Our `rake db:migrate` enhancement automagically ran our SQL so we're good to go!
+
+Let's try it out, in a rails console (`rails c`) 
+```
+2.5.5 :007 > User.first.balance_in_cents;
+ => 0
+
+2.5.5 :008 > Transaction.create(user_id: 1, amount_in_cents: 123, kind: "Transfer")
+ => #<Transaction id: 81, user_id: 1, amount_in_cents: 123, kind: "Transfer", created_at: "2021-06-19 18:05:32", updated_at: "2021-06-19 18:05:32">
+2.5.5 :009 > User.first.balance_in_cents;
+  User Load (1.6ms)  SELECT `users`.* FROM `users` ORDER BY `users`.`id` ASC LIMIT 1
+ => 123
+```
+
+Noice! 
+
+Functions, procedures and events work in the same manner, you can go on and play with them on your own!
+
+## Gotchas
+
+You may want to use alphanumeric names for your SQL function/... names, the generators try normalizing them but just in case, try not to use names like _$up'erk3wl ha{er#name_ or similar gibberish.
+
+
+## Roadmap
+* specs
+* a way to select which database to use, when there are multiple
+
+
+## Contributing
+
+Bug reports are welcome and pull requests are more than welcome on GitHub at https://github.com/freecrap/database_logic. Contributors are expected to adhere to the [code of conduct](https://github.com/freecrap/database_logic/blob/master/CODE_OF_CONDUCT.md). I haven't edited this file yet so until I do please don't be naughty.
+
+## 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,14 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+
+# nick
+#require 'database_logic'
+#path = File.expand_path(__dir__)
+#Dir.glob("#{path}/tasks/*.rake").each { |f| import f }

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "database_logic"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/database_logic.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "lib/database_logic/version"
+
+# TODO write this shit
+
+Gem::Specification.new do |spec|
+  spec.name          = "database_logic"
+  spec.version       = DatabaseLogic::VERSION
+  spec.authors       = ["Nick"]
+  spec.email         = ["nick@flinkwise.com"]
+
+  spec.summary       = "Helps working with database logic."
+  spec.description   = "This gem lets you write SQL functions, procedures, scheduled events, views and triggers/notifications.."
+  spec.homepage      = "https://github.com"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.4.0"
+
+  #spec.metadata["allowed_push_host"] = "to do Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://www.github.com"
+  spec.metadata["changelog_uri"] = "https://www.github.com/changelog.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/Rakefile

@@ -0,0 +1,5 @@
+require 'database_logic'
+
+path = File.expand_path(__dir__)
+Dir.glob("#{path}/tasks/*.rake").each { |f| import f }
+

data/lib/database_logic.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "database_logic/version"
+
+module DatabaseLogic
+  class Error < StandardError; end
+
+  # Your code goes here...
+  require 'database_logic/railtie' if defined?(Rails)
+end

data/lib/database_logic/railtie.rb

@@ -0,0 +1,14 @@
+# lib/railtie.rb
+require 'database_logic'
+require 'rails'
+
+module DatabaseLogic
+  class Railtie < Rails::Railtie
+    railtie_name :database_logic
+
+    rake_tasks do
+      path = File.expand_path(__dir__)
+      Dir.glob("#{path}/tasks/*.rake").each { |f| load f }
+    end
+  end
+end

data/lib/database_logic/tasks/events.rake

@@ -0,0 +1,29 @@
+
+
+namespace :database_logic do
+    
+    namespace :events do
+	desc "Create events"
+	task :create => :environment do
+	    Dir.glob( Rails.root.join("app/sql/events/*.sql") ).sort.each do |f|
+		event_name = File.basename(f).split("_").drop(1).join("_").split(".").first
+		p " + Creating #{event_name}..."
+		ActiveRecord::Base.connection.execute( File.read( f ).gsub("[DB]", ActiveRecord::Base.connection_config[:database]) )
+	    end
+	end
+	
+	desc "Drop events"
+	task :drop => :environment do
+	    Dir.glob( Rails.root.join("app/sql/events/*.sql") ).sort.each do |f|
+		event_name = File.basename(f).split("_").drop(1).join("_").split(".").first
+		p " - Dropping #{event_name}..."
+		ActiveRecord::Base.connection.execute "drop event if exists #{ event_name }"
+	    end
+	end
+	
+	desc "Recreate events (drop & create)"
+	task :recreate => [:drop, :create] do
+	    p "Done!"
+	end
+    end # procedures
+end

data/lib/database_logic/tasks/functions.rake

@@ -0,0 +1,30 @@
+
+
+namespace :database_logic do
+    
+    namespace :functions do
+	desc "Create stored functions"
+	task :create => :environment do
+	    Dir.glob( Rails.root.join("app/sql/functions/*.sql") ).sort.each do |f|
+		function_name = File.basename(f).split("_").drop(1).join("_").split(".").first
+		p " + Creating #{function_name}..."
+		ActiveRecord::Base.connection.execute( File.read( f ).gsub("[DB]", ActiveRecord::Base.connection_config[:database] ) )
+	    end
+	end
+	
+	desc "Drop stored functions"
+	task :drop => :environment do
+	    Dir.glob( Rails.root.join("app/sql/functions/*.sql") ).sort.each do |f|
+		function_name = File.basename(f).split("_").drop(1).join("_").split(".").first
+		p " - Dropping #{function_name}..."
+		ActiveRecord::Base.connection.execute "drop function if exists #{ function_name }"
+	    end
+	end
+	
+	desc "Recreate stored functions (drop & create)"
+	task :recreate => [:drop, :create] do
+	    p "Done!"
+	end
+    end # functions
+    
+end

data/lib/database_logic/tasks/generic.rake

@@ -0,0 +1,36 @@
+
+
+namespace :database_logic do
+    # remove all SQL?
+    desc "Create all stores SQL"
+    task :create => :environment do
+	["events", "triggers", "procedures", "views", "functions"].reverse.each do |t|
+	    Rake::Task["database_logic:#{t}:create"].invoke
+	end
+    end
+    
+    
+    desc "Drop all stored SQL"
+    task :drop => :environment do
+	["events", "triggers", "procedures", "views", "functions"].each do |t|
+	    Rake::Task["database_logic:#{t}:drop"].invoke
+	end
+    end
+    
+    
+    desc "Drop and re-create all stored SQL"
+    task :recreate => :environment do
+	Rake::Task["database_logic:drop"].invoke
+	Rake::Task["database_logic:create"].invoke
+    end
+end
+
+
+# on drop, drop SQL too
+#Rake::Task["db:drop"].enhance ["database_logic:drop"]
+
+
+# on migration, re-run all SQL
+#Rake::Task["db:migrate"].enhance do
+#    Rake::Task["database_logic:recreate"].execute
+#end

data/lib/database_logic/tasks/procedures.rake

@@ -0,0 +1,31 @@
+
+
+namespace :database_logic do
+    
+    namespace :procedures do
+	desc "Create stored procedures"
+	task :create => :environment do
+	    Dir.glob( Rails.root.join("app/sql/procedures/*.sql") ).sort.each do |f|
+		procedure_name = File.basename(f).split("_").drop(1).join("_").split(".").first
+		p " + Creating #{procedure_name}..."
+		ActiveRecord::Base.connection.execute( File.read( f ).gsub("[DB]", ActiveRecord::Base.connection_config[:database] ) )
+	    end
+	end
+	
+	desc "Drop stored procedures"
+	task :drop => :environment do
+	    Dir.glob( Rails.root.join("app/sql/procedures/*.sql") ).sort.each do |f|
+		procedure_name = File.basename(f).split("_").drop(1).join("_").split(".").first
+		p " - Dropping #{procedure_name}..."
+		ActiveRecord::Base.connection.execute "drop procedure if exists #{ procedure_name }"
+	    end
+	end
+	
+	desc "Recreate stored procedures (drop & create)"
+	task :recreate => [:drop, :create] do
+	    p "Done!"
+	end
+    end # procedures
+    
+    
+end

data/lib/database_logic/tasks/triggers.rake

@@ -0,0 +1,30 @@
+
+
+namespace :database_logic do
+    
+    namespace :triggers do
+	desc "Create triggers"
+	task :create => :environment do
+	    Dir.glob( Rails.root.join("app/sql/triggers/*.sql") ).sort.each do |f|
+		trigger_name = File.basename(f).split("_").drop(1).join("_").split(".").first
+		p " + Creating #{trigger_name}..."
+		ActiveRecord::Base.connection.execute( File.read( f ).gsub("[DB]", ActiveRecord::Base.connection_config[:database]) )
+	    end
+	end
+	
+	desc "Drop triggers"
+	task :drop => :environment do
+	    Dir.glob( Rails.root.join("app/sql/triggers/*.sql") ).sort.each do |f|
+		trigger_name = File.basename(f).split("_").drop(1).join("_").split(".").first
+		p " - Dropping #{trigger_name}..."
+		ActiveRecord::Base.connection.execute "drop trigger if exists #{ trigger_name }"
+	    end
+	end
+	
+	desc "Recreate triggers (drop & create)"
+	task :recreate => [:drop, :create] do
+	    p "Done!"
+	end
+    end # triggers
+    
+end

data/lib/database_logic/tasks/views.rake

@@ -0,0 +1,32 @@
+
+
+namespace :database_logic do
+    
+    namespace :views do
+	desc "Create views"
+	task :create => :environment do
+	p "Creating views"
+	    Dir.glob( Rails.root.join("app/sql/views/*.sql") ).sort.each do |f|
+		view_name = File.basename(f).split("_").drop(1).join("_").split(".").first
+		p " + Creating #{view_name}..."
+		ActiveRecord::Base.connection.execute( File.read( f ).gsub("[DB]", ActiveRecord::Base.connection_config[:database]) )
+	    end
+	end
+	
+	desc "Drop views"
+	task :drop => :environment do
+	    Dir.glob( Rails.root.join("app/sql/views/*.sql") ).sort.each do |f|
+		view_name = File.basename(f).split("_").drop(1).join("_").split(".").first
+		p " - Dropping #{view_name}..."
+		ActiveRecord::Base.connection.execute "drop view if exists #{ view_name }"
+	    end
+	end
+	
+	desc "Recreate views (drop & create)"
+	task :recreate => [:drop, :create] do
+	    p "Done!"
+	end
+    end # views
+    
+    
+end

data/lib/database_logic/version.rb

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

data/lib/generators/database_logic/event_generator.rb

@@ -0,0 +1,82 @@
+require 'rails/generators'
+module DatabaseLogic
+  module Generators
+    class EventGenerator < Rails::Generators::Base
+	
+	argument :name, type: :string
+	argument :frequency, type: :string
+	argument :time_unit, type: :string
+	
+	def generate(asset_type = :event)
+	    ensure_path_exists! asset_type
+	    validate_file_name! asset_type
+	    validate_asset_name! asset_type
+	    
+	    @frequency = frequency
+	    validate_frequency!
+	    
+	    @time_unit = time_unit
+	    validate_time_unit!
+	    create_asset! asset_type
+	end
+
+	
+      private
+      
+        def create_asset!(asset_type)
+	    @name = serialized_asset_name
+    	    create_file file_name_with_path(asset_type.to_s.pluralize), ERB.new( File.read( "#{ File.dirname(File.realpath(__FILE__)) }/templates/#{asset_type}.erb.sqlt"  )  ).result(binding)
+        end
+      
+      
+        def ensure_path_exists!(asset_dir)
+    	    FileUtils.mkdir_p Rails.root.join("app/sql/#{ asset_dir.to_s.pluralize }")
+        end
+        
+        
+        def timestamp
+    	    Time.now.strftime("%Y%M%d%H%M%S")
+        end
+        
+        
+        def file_name_with_timestamp
+    	    "#{ timestamp }_#{ serialized_asset_name }"
+        end
+        
+        
+        def file_name_with_path( dir )
+    	    Rails.root.join "app/sql/#{ dir }/#{ file_name_with_timestamp }.sql"
+        end
+        
+        
+        def asset_name
+    	    name
+    	end
+    	
+        
+        def serialized_asset_name
+    	    asset_name.parameterize.underscore
+        end
+        
+        
+        def validate_frequency!
+    	    raise Error.new("Event frequency must be between 1 and 65535") if @frequency.to_i <= 0 || @frequency.to_i > 65535
+        end
+        
+        
+        def validate_time_unit!
+    	    raise Error.new("A scheduled event must execute every second|minute|hour|day|week|month") if !["second", "minute", "hour", "day", "week", "month"].include?(@time_unit.to_s)
+        end
+        
+        
+        def validate_asset_name!( asset_type )
+    	    raise Error.new("#{ asset_type.to_s.capitalize } named #{serialized_asset_name} already exists, please choose another name") if Dir.glob( Rails.root.join( "app/sql/#{ asset_type.to_s.pluralize }/*_#{serialized_asset_name}.sql") ).size > 0
+        end
+
+        
+        def validate_file_name!( asset_type )
+    	    raise Error.new("File #{file_name_with_timestamp} already exists") if File.exist?( file_name_with_path( asset_type.to_s.pluralize ) )
+        end
+    end
+  end
+end

data/lib/generators/database_logic/function_generator.rb

@@ -0,0 +1,64 @@
+require 'rails/generators'
+module DatabaseLogic
+  module Generators
+    class FunctionGenerator < Rails::Generators::Base
+	
+	argument :name, type: :string
+	
+	def generate(asset_type = :function)
+	    ensure_path_exists! asset_type
+	    validate_file_name! asset_type
+	    validate_asset_name! asset_type
+	    create_asset! asset_type
+	end
+
+	
+      private
+      
+        def create_asset!(asset_type)
+	    @name = serialized_asset_name
+    	    create_file file_name_with_path(asset_type.to_s.pluralize), ERB.new( File.read( "#{ File.dirname(File.realpath(__FILE__)) }/templates/#{asset_type}.erb.sqlt"  )  ).result(binding)
+        end
+      
+      
+        def ensure_path_exists!(asset_dir)
+    	    FileUtils.mkdir_p Rails.root.join("app/sql/#{ asset_dir.to_s.pluralize }")
+        end
+        
+        
+        def timestamp
+    	    Time.now.strftime("%Y%M%d%H%M%S")
+        end
+        
+        
+        def file_name_with_timestamp
+    	    "#{ timestamp }_#{ serialized_asset_name }"
+        end
+        
+        
+        def file_name_with_path( dir )
+    	    Rails.root.join "app/sql/#{ dir }/#{ file_name_with_timestamp }.sql"
+        end
+        
+        
+        def asset_name
+    	    name
+    	end
+    	
+        
+        def serialized_asset_name
+    	    asset_name.parameterize.underscore
+        end
+        
+        
+        def validate_asset_name!( asset_type )
+    	    raise Error.new("#{ asset_type.to_s.capitalize } named #{serialized_asset_name} already exists, please choose another name") if Dir.glob( Rails.root.join( "app/sql/#{ asset_type.to_s.pluralize }/*_#{serialized_asset_name}.sql") ).size > 0
+        end
+
+        
+        def validate_file_name!( asset_type )
+    	    raise Error.new("File #{file_name_with_timestamp} already exists") if File.exist?( file_name_with_path( asset_type.to_s.pluralize ) )
+        end
+    end
+  end
+end

data/lib/generators/database_logic/procedure_generator.rb

@@ -0,0 +1,64 @@
+require 'rails/generators'
+module DatabaseLogic
+  module Generators
+    class ProcedureGenerator < Rails::Generators::Base
+	
+	argument :name, type: :string
+	
+	def generate(asset_type = :procedure)
+	    ensure_path_exists! asset_type
+	    validate_file_name! asset_type
+	    validate_asset_name! asset_type
+	    create_asset! asset_type
+	end
+
+	
+      private
+      
+        def create_asset!(asset_type)
+	    @name = serialized_asset_name
+    	    create_file file_name_with_path(asset_type.to_s.pluralize), ERB.new( File.read( "#{ File.dirname(File.realpath(__FILE__)) }/templates/#{asset_type}.erb.sqlt"  )  ).result(binding)
+        end
+      
+      
+        def ensure_path_exists!(asset_dir)
+    	    FileUtils.mkdir_p Rails.root.join("app/sql/#{ asset_dir.to_s.pluralize }")
+        end
+        
+        
+        def timestamp
+    	    Time.now.strftime("%Y%M%d%H%M%S")
+        end
+        
+        
+        def file_name_with_timestamp
+    	    "#{ timestamp }_#{ serialized_asset_name }"
+        end
+        
+        
+        def file_name_with_path( dir )
+    	    Rails.root.join "app/sql/#{ dir }/#{ file_name_with_timestamp }.sql"
+        end
+        
+        
+        def asset_name
+    	    name
+    	end
+    	
+        
+        def serialized_asset_name
+    	    asset_name.parameterize.underscore
+        end
+        
+        
+        def validate_asset_name!( asset_type )
+    	    raise Error.new("#{ asset_type.to_s.capitalize } named #{serialized_asset_name} already exists, please choose another name") if Dir.glob( Rails.root.join( "app/sql/#{ asset_type.to_s.pluralize }/*_#{serialized_asset_name}.sql") ).size > 0
+        end
+
+        
+        def validate_file_name!( asset_type )
+    	    raise Error.new("File #{file_name_with_timestamp} already exists") if File.exist?( file_name_with_path( asset_type.to_s.pluralize ) )
+        end
+    end
+  end
+end

data/lib/generators/database_logic/templates/event.erb.sqlt

@@ -0,0 +1,5 @@
+create event <%= @name %> on schedule every <%= @frequency %> <%= @time_unit %> on completion preserve do
+begin
+   # your SQL goes in here
+   # select * from <%= @db %>.table ...
+end;

data/lib/generators/database_logic/templates/function.erb.sqlt

@@ -0,0 +1,8 @@
+create function [DB].<%= @name %>(some_parameter int) returns int
+deterministic
+reads sql data
+begin
+  # do something here
+  return 0
+end;
+

data/lib/generators/database_logic/templates/procedure.erb.sqlt

@@ -0,0 +1,6 @@
+create procedure [DB].<%= name %>(IN parameter int)
+begin
+
+  # your SQL goes here
+
+end;

data/lib/generators/database_logic/templates/trigger.erb.sqlt

@@ -0,0 +1,5 @@
+create trigger <%= name %> <%= @run_when %> <%= @sql_action %> on [DB].<%= @table %>
+for each row
+    begin
+	# do something with NEW.<%= @table.singularize %>_ATTRIBUTE...
+    end;

data/lib/generators/database_logic/templates/view.erb.sqlt

@@ -0,0 +1,16 @@
+create or replace view [DB].<%= @name %> as
+    # add your SQL here
+    # select * from [DB].table where...
+    
+    # Tip: you can also back views with read-only models, eg:
+    
+    # class YourModel < ApplicationRecord
+    #   self.table_name = "<%= @name %>"
+    #   
+    #   def readonly?
+    #     true
+    #   end
+    # end
+    
+    
+    # this is useful for instance for reporting purpose where your view may also be used by external applications

data/lib/generators/database_logic/trigger_generator.rb

@@ -0,0 +1,93 @@
+require 'rails/generators'
+module DatabaseLogic
+  module Generators
+    class TriggerGenerator < Rails::Generators::Base
+	
+	argument :name, type: :string
+	argument :run_when, type: :string
+	argument :sql_action, type: :string
+	argument :table, type: :string
+	
+	# <%= name %> <%= @when %> <%= @sql_action %> on <%= @table %>
+	
+	def generate(asset_type = :trigger)
+	    ensure_path_exists! asset_type
+	    validate_file_name! asset_type
+	    validate_asset_name! asset_type
+	    
+	    @when = run_when
+	    validate_when!
+	    
+	    @sql_action = sql_action
+	    validate_sql_action!
+	    
+	    @table = table
+	    validate_table!
+	    
+	    create_asset! asset_type
+	end
+
+	
+      private
+      
+        def create_asset!(asset_type)
+	    @name = serialized_asset_name
+    	    create_file file_name_with_path(asset_type.to_s.pluralize), ERB.new( File.read( "#{ File.dirname(File.realpath(__FILE__)) }/templates/#{asset_type}.erb.sqlt"  )  ).result(binding)
+        end
+      
+      
+        def ensure_path_exists!(asset_dir)
+    	    FileUtils.mkdir_p Rails.root.join("app/sql/#{ asset_dir.to_s.pluralize }")
+        end
+        
+        
+        def timestamp
+    	    Time.now.strftime("%Y%M%d%H%M%S")
+        end
+        
+        
+        def file_name_with_timestamp
+    	    "#{ timestamp }_#{ serialized_asset_name }"
+        end
+        
+        
+        def file_name_with_path( dir )
+    	    Rails.root.join "app/sql/#{ dir }/#{ file_name_with_timestamp }.sql"
+        end
+        
+        
+        def asset_name
+    	    name
+    	end
+    	
+        
+        def serialized_asset_name
+    	    asset_name.parameterize.underscore
+        end
+        
+        
+        def validate_table!
+    	    raise Error.new("Must specify a table to attach trigger to") if @table.empty?
+    	    # TODO check if table really exists
+        end
+        
+        def validate_sql_action!
+    	    raise Error.new("Trigger must run either on insert, update, create or delete") if !["insert", "update", "create", "delete"].include?(@sql_action.downcase)
+        end
+        
+        def validate_when!
+    	    raise Error.new("Trigger must run either before or after") if !["before", "after"].include?(@run_when.downcase)
+        end
+        
+        
+        def validate_asset_name!( asset_type )
+    	    raise Error.new("#{ asset_type.to_s.capitalize } named #{serialized_asset_name} already exists, please choose another name") if Dir.glob(Rails.root.join("app/sql/#{ asset_type.to_s.pluralize }/*_#{serialized_asset_name}.sql")).size > 0
+        end
+
+        
+        def validate_file_name!( asset_type )
+    	    raise Error.new("File #{file_name_with_timestamp} already exists") if File.exist?( file_name_with_path( asset_type.to_s.pluralize ) )
+        end
+    end
+  end
+end

data/lib/generators/database_logic/view_generator.rb

@@ -0,0 +1,64 @@
+require 'rails/generators'
+module DatabaseLogic
+  module Generators
+    class ViewGenerator < Rails::Generators::Base
+	
+	argument :name, type: :string
+	
+	def generate(asset_type = :view)
+	    ensure_path_exists! asset_type
+	    validate_file_name! asset_type
+	    validate_asset_name! asset_type
+	    create_asset! asset_type
+	end
+
+	
+      private
+      
+        def create_asset!(asset_type)
+	    @name = serialized_asset_name
+    	    create_file file_name_with_path(asset_type.to_s.pluralize), ERB.new( File.read( "#{ File.dirname(File.realpath(__FILE__)) }/templates/#{asset_type}.erb.sqlt"  )  ).result(binding)
+        end
+      
+      
+        def ensure_path_exists!(asset_dir)
+    	    FileUtils.mkdir_p Rails.root.join("app/sql/#{ asset_dir.to_s.pluralize }")
+        end
+        
+        
+        def timestamp
+    	    Time.now.strftime("%Y%M%d%H%M%S")
+        end
+        
+        
+        def file_name_with_timestamp
+    	    "#{ timestamp }_#{ serialized_asset_name }"
+        end
+        
+        
+        def file_name_with_path( dir )
+    	    Rails.root.join "app/sql/#{ dir }/#{ file_name_with_timestamp }.sql"
+        end
+        
+        
+        def asset_name
+    	    name
+    	end
+    	
+        
+        def serialized_asset_name
+    	    asset_name.parameterize.underscore
+        end
+        
+        
+        def validate_asset_name!( asset_type )
+    	    raise Error.new("#{ asset_type.to_s.capitalize } named #{serialized_asset_name} already exists, please choose another name") if Dir.glob(Rails.root.join("app/sql/#{ asset_type.to_s.pluralize }/*_#{serialized_asset_name}.sql")).size > 0
+        end
+
+        
+        def validate_file_name!( asset_type )
+    	    raise Error.new("File #{file_name_with_timestamp} already exists") if File.exist?( file_name_with_path( asset_type.to_s.pluralize ) )
+        end
+    end
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: database_logic
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nick
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-06-19 00:00:00.000000000 Z
+dependencies: []
+description: This gem lets you write SQL functions, procedures, scheduled events,
+  views and triggers/notifications..
+email:
+- nick@flinkwise.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- database_logic.gemspec
+- lib/Rakefile
+- lib/database_logic.rb
+- lib/database_logic/railtie.rb
+- lib/database_logic/tasks/events.rake
+- lib/database_logic/tasks/functions.rake
+- lib/database_logic/tasks/generic.rake
+- lib/database_logic/tasks/procedures.rake
+- lib/database_logic/tasks/triggers.rake
+- lib/database_logic/tasks/views.rake
+- lib/database_logic/version.rb
+- lib/generators/database_logic/event_generator.rb
+- lib/generators/database_logic/function_generator.rb
+- lib/generators/database_logic/procedure_generator.rb
+- lib/generators/database_logic/templates/event.erb.sqlt
+- lib/generators/database_logic/templates/function.erb.sqlt
+- lib/generators/database_logic/templates/procedure.erb.sqlt
+- lib/generators/database_logic/templates/trigger.erb.sqlt
+- lib/generators/database_logic/templates/view.erb.sqlt
+- lib/generators/database_logic/trigger_generator.rb
+- lib/generators/database_logic/view_generator.rb
+homepage: https://github.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com
+  source_code_uri: https://www.github.com
+  changelog_uri: https://www.github.com/changelog.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key: 
+specification_version: 4
+summary: Helps working with database logic.
+test_files: []