upknit 0.9.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 36b93e53c0a99f134394333ccc3bc21e409adbe7
+  data.tar.gz: 0227d085fb4b67afd1b2047fcaea918a7d0993a8
+SHA512:
+  metadata.gz: ac5601670b24225e1c03efe1d0bba347f63c7fb71c8d2be25086d7604680b0ad38e65e0cc51eacb300536cc76d51c382243667480e6bdb16ec3806492be0fdd8
+  data.tar.gz: 6cb3593354e3cf5891f5100c3cc1cbd4612c530342efcde8d8f9ff24171857b7d6f5d844b18ed8edcf7a399d917381693a42c9de4a954174be6344abb1bf2874

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 OZAWA Sakuro
+
+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,27 @@
+# Upknit
+
+Adding this gem to a Rails application with PostgreSQL automatically enables UUID primary key.
+
+## Usage
+
+Add this gem to your Rails application.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'upknit'
+
+And then execute:
+
+    $ bundle
+
+## Internals
+
+This gem does two things to enable UUID primary key.
+
+1. Enable PostgreSQL's extension for calculation of UUID(v4).
+2. Configure generators to use UUID as primary key for newly generated tables.
+
+## 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,16 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+APP_RAKEFILE = File.expand_path('../spec/dummy/Rakefile', __FILE__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+load 'rspec/rails/tasks/rspec.rake'
+
+Dir['lib/tasks/*.rake'].each(&method(:load))

data/lib/tasks/rubocop.rake

@@ -0,0 +1,7 @@
+begin
+  require 'rubocop/rake_task'
+
+  RuboCop::RakeTask.new
+rescue LoadError # rubocop:disable Lint/HandleExceptions
+  # skip rubocop tasks
+end

data/lib/tasks/yard.rake

@@ -0,0 +1,8 @@
+begin
+  require 'yard'
+  require 'yard/rake/yardoc_task'
+
+  YARD::Rake::YardocTask.new
+rescue LoadError # rubocop:disable Lint/HandleExceptions
+  # skip yard tasks
+end

data/lib/upknit/connection_extension/postgresql.rb

@@ -0,0 +1,38 @@
+require 'active_record/connection_adapters/postgresql_adapter'
+
+# An extension to {ActiveRecord::ConnectionAdapters::PostgresqlAdapter}.
+#
+# When included, this module adds two methods to support UUID extension
+# * #enable_uuid
+# * #uuid_extension
+module Upknit
+  module ConnectionExtension
+    module PostgreSQL
+      # Enables a extension which adds UUID function to the system.
+      # @return [void]
+      def enable_uuid
+        enable_extension(uuid_extension)
+      end
+
+      # Returns the name of UUID extension which should be used in current connection.
+      # @return [String] Name of the extension
+      def uuid_extension
+        (UUID_EXTENSIONS & available_extensions).first
+      end
+
+      private
+
+      # UUID support extensions in desired order
+      # Note: Use of uuid-ossp for random UUID(v4) is discouraged
+      # https://www.postgresql.org/docs/9.6/static/uuid-ossp.html
+      UUID_EXTENSIONS = %w(pgcrypto uuid-ossp).freeze
+      private_constant :UUID_EXTENSIONS
+
+      def available_extensions
+        exec_query('SELECT Name FROM pg_available_extensions').cast_values
+      end
+    end
+  end
+end
+
+ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.include Upknit::ConnectionExtension::PostgreSQL

data/lib/upknit/connection_extension.rb

@@ -0,0 +1 @@
+require 'upknit/connection_extension/postgresql'

data/lib/upknit/enable_uuid_extension_on_create/postgresql.rb

@@ -0,0 +1,18 @@
+require 'active_record/tasks/postgresql_database_tasks'
+
+module Upknit
+  module EnableUuidExtensionOnCreate
+    module PostgreSQL
+      def create(master_established=false)
+        super
+        connection.enable_uuid
+      end
+
+      def self.prepend(mod)
+        mod.extend(self)
+      end
+    end
+  end
+end
+
+ActiveRecord::Tasks::PostgreSQLDatabaseTasks.prepend Upknit::EnableUuidExtensionOnCreate::PostgreSQL

data/lib/upknit/enable_uuid_extension_on_create.rb

@@ -0,0 +1 @@
+require 'upknit/enable_uuid_extension_on_create/postgresql'

data/lib/upknit/engine.rb

@@ -0,0 +1,8 @@
+module Upknit
+  class Engine < ::Rails::Engine
+  end
+end
+
+require 'upknit/connection_extension'
+require 'upknit/enable_uuid_extension_on_create'
+require 'upknit/set_default_primary_key_to_uuid'

data/lib/upknit/set_default_primary_key_to_uuid.rb

@@ -0,0 +1,28 @@
+require 'active_support/concern'
+require 'upknit/connection_extension'
+
+module Upknit
+  module SetDefaultPrimaryKeyToUuid
+    extend ActiveSupport::Concern
+
+    included do
+      initializer 'upknit.set_default_primary_key_to_uuid', after: :load_config_initializers do
+        ActiveRecord::Base.establish_connection
+        uuid_extension = ActiveRecord::Base.connection&.uuid_extension
+        config.app_generators do |g|
+          case uuid_extension
+          when 'pgcrypto'
+            g.orm :active_record, primary_key_type: :uuid
+          when 'uuid-ossp'
+            g.orm :active_record, primary_key_type: 'uuid, default: -> { "uuid_generate_v4()" }'
+          else
+            $stderr.ptus 'upknit gem is installed, but UUUID is not supported'
+            # UUID not supported
+          end
+        end
+      end
+    end
+  end
+end
+
+Upknit::Engine.include Upknit::SetDefaultPrimaryKeyToUuid

data/lib/upknit/version.rb

@@ -0,0 +1,3 @@
+module Upknit
+  VERSION = '0.9.1'.freeze
+end

data/lib/upknit.rb

@@ -0,0 +1,5 @@
+require 'upknit/engine'
+
+module Upknit
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: upknit
+version: !ruby/object:Gem::Version
+  version: 0.9.1
+platform: ruby
+authors:
+- OZAWA Sakuro
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.1
+- !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: rspec-rails
+  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: yard
+  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: kramdown
+  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: rubocop
+  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: rubocop-rspec
+  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: |
+  This rails engine configures necessary settings to enable native UUID primary key
+  in rails + postgresql environment.
+email:
+- sakuro@2238club.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/tasks/rubocop.rake
+- lib/tasks/yard.rake
+- lib/upknit.rb
+- lib/upknit/connection_extension.rb
+- lib/upknit/connection_extension/postgresql.rb
+- lib/upknit/enable_uuid_extension_on_create.rb
+- lib/upknit/enable_uuid_extension_on_create/postgresql.rb
+- lib/upknit/engine.rb
+- lib/upknit/set_default_primary_key_to_uuid.rb
+- lib/upknit/version.rb
+homepage: https://github.com/sakuro/upknit
+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.6.11
+signing_key: 
+specification_version: 4
+summary: UUID primary key enabler for rails.
+test_files: []