pg_assistant 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6e971d86dbefb599de8da9d7d4c0af420cc03d48
+  data.tar.gz: 01243c8875722d96a3d23bfb113d4123009ef1af
+SHA512:
+  metadata.gz: b3c30707d20bd84edc389b6694a24985e7e88ef530dbe9dbc64c12c2f65b0b6e7e8ac3a51b8de7ee9ce338b1f7abcf88dea86e98cd59805db39039bd1d5efe26
+  data.tar.gz: e90890bf00c3eec1fe11194f5106e75235b2583768c561de75ec8e9181e3ec57ea221b24e084cb62f48c85e9d84427c21627ba5c0e5680b95925c2a190443a18

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.2.4

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in pg_assistant.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 German Antsiferov
+
+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,40 @@
+# PgAssistant
+
+Adds methods to ActiveRecord::Migration to create and manage database functions in Rails.
+I took the idea from a project [Scenic](https://github.com/thoughtbot/scenic).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pg_assistant'
+```
+
+## Setup config
+
+```ruby
+PgAssistant.configure do |config|
+  config.functions_directory_path = '<your path>' # by default db/functions
+end
+```
+
+## Usage
+
+Create or update function:
+
+``` bash
+rails generate pg_assistant:function increment
+
+# => create: db/functions/increment_v01.sql
+# => create: db/functions/20140803191158_create_increment.rb
+
+rails generate pg_assistant:function increment
+
+# => create: db/functions/increment_v02.sql
+# => create: db/functions/20140804191158_update_increment_to_version_2.rb
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pg_assistant"
+
+# 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/lib/generators/pg_assistant/function/USAGE

@@ -0,0 +1,17 @@
+Description:
+  Create a new database function for your application. This will create a new
+  function definition file and the accompanying migration.
+
+  If a function of the given name already exists, create a new version of the function
+  and a migration to replace the old version with the new.
+
+Examples:
+    rails generate pg_assistant:function increment
+
+      create: db/functions/increment_v01.sql
+      create: db/functions/20140803191158_create_increment.rb
+
+    rails generate pg_assistant:function increment
+
+      create: db/functions/increment_v02.sql
+      create: db/functions/20140804191158_update_increment_to_version_2.rb

data/lib/generators/pg_assistant/function/function_generator.rb

@@ -0,0 +1,107 @@
+require 'rails/generators'
+require "rails/generators/active_record"
+
+module PgAssistant
+  module Generators
+    class FunctionGenerator < Rails::Generators::NamedBase
+      include Rails::Generators::Migration
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      def create_functions_directory
+        unless functions_directory_path.exist?
+          empty_directory functions_directory_path
+        end
+      end
+
+      def create_function_definition
+        if creating_new_function?
+          create_file definition.path
+        else
+          copy_file previous_definition.full_path, definition.full_path
+        end
+      end
+
+      def create_migration_file
+        if creating_new_function? || destroying_initial_function?
+          migration_template(
+            "db/migrate/create_function.erb",
+            "db/migrate/create_#{function_name}.rb"
+          )
+        else
+          migration_template(
+            "db/migrate/update_function.erb",
+            "db/migrate/update_#{function_name}_to_version_#{version}.rb"
+          )
+        end
+      end
+
+      def self.next_migration_number(dir)
+        ::ActiveRecord::Generators::Base.next_migration_number(dir)
+      end
+
+      no_tasks do
+        def previous_version
+          @previous_version ||=
+            Dir.entries(functions_directory_path)
+              .map { |name| version_regex.match(name).try(:[], "version").to_i }
+              .max
+        end
+
+        def version
+          @version ||= destroying? ? previous_version : previous_version.next
+        end
+
+        def migration_class_name
+          if creating_new_function?
+            "Create#{class_name.gsub('.', '')}"
+          else
+            "Update#{class_name}ToVersion#{version}"
+          end
+        end
+
+        def activerecord_migration_class
+          if ActiveRecord::Migration.respond_to?(:current_version)
+            "ActiveRecord::Migration[#{ActiveRecord::Migration.current_version}]"
+          else
+            "ActiveRecord::Migration"
+          end
+        end
+
+        def definition
+          PgAssistant::Definitions::Function.new(function_name, version)
+        end
+
+        def previous_definition
+          PgAssistant::Definitions::Function.new(function_name, previous_version)
+        end
+      end
+
+      private
+
+      def functions_directory_path
+        @functions_directory_path ||= Rails.root.join PgAssistant::Definitions::Function.directory_path
+      end
+
+      def version_regex
+        /\A#{function_name}_v(?<version>\d+)\.sql\z/
+      end
+
+      def function_name
+        @function_name ||= file_name.gsub(".", "_")
+      end
+
+      def destroying?
+        behavior == :revoke
+      end
+
+      def creating_new_function?
+        previous_version == 0
+      end
+
+      def destroying_initial_function?
+        destroying? && version == 1
+      end
+    end
+  end
+end

data/lib/generators/pg_assistant/function/templates/db/migrate/create_function.erb

@@ -0,0 +1,13 @@
+class <%= migration_class_name %> < <%= activerecord_migration_class %>
+  def up
+    connection.execute Rails.root.join('<%= definition.path -%>').read
+  end
+
+  def down
+    # connection.execute <<-SQL
+    #  DROP FUNCTION <%= class_name %>(your arguments);
+    # SQL
+
+    raise ActiveRecord::IrreversibleMigration
+  end
+end

data/lib/generators/pg_assistant/function/templates/db/migrate/update_function.erb

@@ -0,0 +1,9 @@
+class <%= migration_class_name %> < <%= activerecord_migration_class %>
+  def up
+    connection.execute Rails.root.join('<%= definition.path -%>').read
+  end
+
+  def down
+    connection.execute Rails.root.join('<%= previous_definition.path -%>').read
+  end
+end

data/lib/generators/pg_assistant/generators.rb

@@ -0,0 +1,4 @@
+module PgAssistant
+  module Generators
+  end
+end

data/lib/pg_assistant.rb

@@ -0,0 +1,18 @@
+require 'pg_assistant/version'
+require 'pg_assistant/definitions'
+
+module PgAssistant
+  class << self
+    def configure(&block)
+      yield(self)
+    end
+
+    def functions_directory_path=(path)
+      Definitions::Function.directory_path = path
+    end
+  end
+end
+
+PgAssistant.configure do |config|
+  config.functions_directory_path = 'db/functions'
+end

data/lib/pg_assistant/definitions.rb

@@ -0,0 +1,7 @@
+require 'pg_assistant/definitions/base'
+require 'pg_assistant/definitions/function'
+
+module PgAssistant
+  module Definitions
+  end
+end

data/lib/pg_assistant/definitions/base.rb

@@ -0,0 +1,38 @@
+module PgAssistant
+  module Definitions
+    class Base
+      class << self
+        attr_reader :directory_path
+
+        def directory_path=(path_raw)
+          @directory_path = Pathname.new(path_raw)
+        end
+      end
+
+      def initialize(name, version)
+        @name = name
+        @version = version.to_i
+      end
+
+      def to_sql
+        File.read(full_path)
+      end
+
+      def full_path
+        Rails.root.join(path)
+      end
+
+      def path
+        self.class.directory_path.join(filename)
+      end
+
+      def version
+        @version.to_s.rjust(2, "0")
+      end
+
+      def filename
+        "#{@name}_v#{version}.sql"
+      end
+    end
+  end
+end

data/lib/pg_assistant/definitions/function.rb

@@ -0,0 +1,6 @@
+module PgAssistant
+  module Definitions
+    class Function < Base
+    end
+  end
+end

data/lib/pg_assistant/version.rb

@@ -0,0 +1,3 @@
+module PgAssistant
+  VERSION = "0.1.0"
+end

data/pg_assistant.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "pg_assistant/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "pg_assistant"
+  spec.version       = PgAssistant::VERSION
+  spec.authors       = ["German Antsiferov"]
+  spec.email         = ["dxdy@bk.ru"]
+
+  spec.summary       = %q{Support for database functions in Rails migrations}
+  spec.description   = <<-DESCRIPTION
+    Adds methods to ActiveRecord::Migration to create and manage database functions in Rails
+  DESCRIPTION
+
+  spec.homepage      = "https://github.com/mr-dxdy/pg_assistant.git"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", ">= 1.15"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", ">= 3.3"
+  spec.add_development_dependency 'ammeter', '>= 1.1.3'
+  spec.add_development_dependency 'pg'
+  spec.add_development_dependency 'byebug'
+
+  spec.add_dependency 'activerecord', '>= 4.0.0'
+  spec.add_dependency 'railties', '>= 4.0.0'
+
+  spec.required_ruby_version = '~> 2.1'
+end

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: pg_assistant
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- German Antsiferov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: ammeter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+- !ruby/object:Gem::Dependency
+  name: pg
+  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'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+description: |2
+      Adds methods to ActiveRecord::Migration to create and manage database functions in Rails
+email:
+- dxdy@bk.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/pg_assistant/function/USAGE
+- lib/generators/pg_assistant/function/function_generator.rb
+- lib/generators/pg_assistant/function/templates/db/migrate/create_function.erb
+- lib/generators/pg_assistant/function/templates/db/migrate/update_function.erb
+- lib/generators/pg_assistant/generators.rb
+- lib/pg_assistant.rb
+- lib/pg_assistant/definitions.rb
+- lib/pg_assistant/definitions/base.rb
+- lib/pg_assistant/definitions/function.rb
+- lib/pg_assistant/version.rb
+- pg_assistant.gemspec
+homepage: https://github.com/mr-dxdy/pg_assistant.git
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Support for database functions in Rails migrations
+test_files: []