sixarm_ruby_migration_helper_extensions 3.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 31b928178a99fe07a06b43da5d774309893310bc0b2f5cc921128d0e9debf13c
+  data.tar.gz: 280e66028e93230891d668885c4f062ee32ae0cf0ba3bfac7a45751bbfa4e9fe
+SHA512:
+  metadata.gz: 85fa31dae1edf1415220ec8cce1da52b02eab3aae8cd206ee7edfc1ae5a6fc20c09f60a89b8d8f71a5485a10e7d0c2bcceb08c5d3b375208d99c05c204a8613c
+  data.tar.gz: 7987a4ffcdcbe5e004ec01c1cd66f10f09c99d7d891d47bf2c785c37b27127382251cd142f36f5db5ada9abc99bc4b4e038d2900f7c2ccf5f5672705ca78dba9

data/Rakefile

@@ -0,0 +1,10 @@
+# -*- coding: utf-8 -*-
+require "rake"
+require "rake/testtask"
+
+task :default => :test
+
+Rake::TestTask.new(:test) do |t|
+  t.libs.push("lib", "test")
+  t.pattern = "test/**/*.rb"
+end

data/lib/sixarm_ruby_migration_helper_extensions.rb

@@ -0,0 +1,197 @@
+# -*- coding: utf-8 -*-
+=begin rdoc
+Please see README
+=end
+
+module Ddb
+  module SixArm
+
+    module MigrationHelper
+
+      def self.included(base) # :nodoc:
+        base.send(:include, InstanceMethods)
+      end
+
+      module InstanceMethods
+
+        ##
+        #
+        # Contact
+        #
+        ##
+
+        ##
+        # Name
+        #
+        def name(column_name=:name)
+          column(column_name, :string)
+          index(column_name)
+        end
+
+        ##
+        # email: string limit is 320 because the email spec has pieces
+        # that total to 320, though then trims the limit to 254.
+        #
+        def email(column_name=:email)
+          column(column_name, :string, limit: 320)
+          index(column_name)
+        end
+
+        ##
+        # phone: string limit is 75 because that's our arbitrary limit,
+        # and long enough for international numbers and extensions.
+        #
+        def phone(column_name=:phone)
+          column(column_name, :string)
+          index(column_name)
+        end
+
+        ##
+        # uri: string is unlimited.
+        #
+        def uri(column_name=:uri)
+          column(column_name, :string)
+          index(column_name)
+        end
+
+        ##
+        #
+        # Size
+        #
+        ##
+
+        def height        (column_name=:height)       column(column_name, :decimal, precision: 13, scale: 10) end
+        def length        (column_name=:length)       column(column_name, :decimal, precision: 13, scale: 10) end
+        def width         (column_name=:width)        column(column_name, :decimal, precision: 13, scale: 10) end
+        def depth         (column_name=:depth)        column(column_name, :decimal, precision: 13, scale: 10) end
+        def mass          (column_name=:mass)         column(column_name, :decimal, precision: 13, scale: 10) end
+
+        ##
+        #
+        # Geolocation
+        #
+        ##
+
+        def latitude      (column_name=:latitude)     column(column_name, :decimal, precision: 13, scale: 10); index(column_name); end
+        def longitude     (column_name=:longitude)    column(column_name, :decimal, precision: 13, scale: 10); index(column_name); end
+        def altitude      (column_name=:altitude)     column(column_name, :decimal, precision: 13, scale: 10); index(column_name); end
+
+        def geolocation
+          latitude
+          longitude
+          altitude
+        end
+
+        ##
+        #
+        # Vendors
+        #
+        ##
+
+        def freebase(column_name=:freebase)
+          column(column_name, :string)
+        end
+
+        ##
+        #
+        # Administration
+        #
+        ##
+
+        ##
+        # uuid_string: we sometimes like to use UUID strings; 
+        # for efficiency, we suggest using a database-native format.
+        #
+        def uuid_string(column_name=:uuid_string)
+          column(column_name, :string, limit: 36)
+          index(column_name, unique: true)
+        end
+
+        ##
+        # parent_id: we sometimes use parent-child relationships,
+        # where `parent_id` points to the parent row.
+        #
+        def parent_id(column_name=:parent_id)
+          column(column_name, :integer)
+          index(column_name)
+        end
+
+        ##
+        # position: we sometimes like to use ordered lists, 
+        # where the `position` is the list position.
+        #
+        def position(column_name=:position)
+          column(column_name, :integer)
+          index(column_name)
+        end
+
+        ##
+        # state: we sometimes like to use state machines, 
+        # where the `state` is an integer enumeration.
+        #
+        def state(column_name=:state)
+          column(column_name, :integer)
+          index(column_name)
+        end
+
+        ##
+        # lock_version: Rails row locking using either
+        # optimistic locking or pessimistic locking.
+        #
+        def lock_version(column_name=:lock_version)
+          column(column_name, :integer)
+          index(column_name)
+        end
+
+        ##
+        # type: Rails single table inheritance (STI) 
+        # uses a magic field name `type`.
+        #
+        def type(column_name=:type)
+          column(column_name, :string)
+          index(column_name)
+        end  
+
+        ##
+        # auditstamps: we like to track what's happening to a row,
+        # by using typical Rails timestamps and then some more.
+        #
+        def auditstamps
+          column(:created_at, :datetime); index(:created_at); column(:created_by, :integer); index(:created_by)
+          column(:updated_at, :datetime); index(:updated_at); column(:updated_by, :integer); index(:updated_by)
+          column(:proofed_at, :datetime); index(:proofed_at); column(:proofed_by, :integer); index(:proofed_by)
+          column(:retired_at, :datetime); index(:retired_at); column(:retired_by, :integer); index(:retired_by)
+        end
+
+        ##
+        # Database administration
+        #
+        # We build many Rails apps and we like to add some columns
+        # that help with database administration and easy growth.
+        #
+        # We like to add these columns during setup, even if we don't
+        # use them, because they make syncronization easy, and they
+        # work with some of our data auditing shared code.
+        #
+        # Use what you like, customize as you like, YMMV, etc.
+        #
+        def dba
+          uuid_string
+          auditstamps
+          lock_version
+          state
+          parent_id
+          position
+          type
+        end
+
+      end
+    end
+  end
+end
+
+require "active_record"
+if defined?(ActiveRecord::ConnectionAdapters::TableDefinition)
+   ActiveRecord::ConnectionAdapters::TableDefinition.send(:include, Ddb::SixArm::MigrationHelper)
+end
+

data/test/sixarm_ruby_migration_helper_extensions_test.rb

@@ -0,0 +1,44 @@
+# -*- coding: utf-8 -*-
+require "minitest/autorun"
+require "simplecov"
+SimpleCov.start
+require "sixarm_ruby_active_record_migration_mock"
+require "sixarm_ruby_migration_helper_extensions"
+
+class Testing < Minitest::Test
+ 
+ def test_columns
+  CreateFoos.up
+  for col in [:email,:freebase,:height,:latitude,:length,:longitude,:phone,:thickness,:uri,:weight,:width] do
+    assert(ActiveRecordMigrationMock.tables['foos'].has_column?(col),"has_column?(:#{col})")
+  end
+ end
+
+end
+
+
+class ActiveRecordMigrationTableMock
+  include Ddb::SixArm::MigrationHelper
+end
+
+
+class CreateFoos < ActiveRecordMigrationMock
+
+  def self.up
+    create_table 'foos', :force => true do |t|
+      t.email
+      t.freebase
+      t.height
+      t.latitude
+      t.latitude
+      t.length
+      t.longitude
+      t.phone
+      t.thickness
+      t.uri
+      t.weight
+      t.width
+    end
+  end
+
+end

metadata

@@ -0,0 +1,223 @@
+--- !ruby/object:Gem::Specification
+name: sixarm_ruby_migration_helper_extensions
+version: !ruby/object:Gem::Version
+  version: 3.0.0
+platform: ruby
+authors:
+- SixArm
+autorequire: 
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIFPDCCAyQCCQDx7Y5LWGuPPzANBgkqhkiG9w0BAQsFADBgMQswCQYDVQQGEwJV
+  UzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzEP
+  MA0GA1UECgwGU2l4QXJtMRMwEQYDVQQDDApzaXhhcm0uY29tMB4XDTE4MDExMzIy
+  NDYyM1oXDTIwMTAwOTIyNDYyM1owYDELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNh
+  bGlmb3JuaWExFjAUBgNVBAcMDVNhbiBGcmFuY2lzY28xDzANBgNVBAoMBlNpeEFy
+  bTETMBEGA1UEAwwKc2l4YXJtLmNvbTCCAiIwDQYJKoZIhvcNAQEBBQADggIPADCC
+  AgoCggIBAMMPPjYWd77gRmOEkMb+1H9+ckIHlA325OkES2g5Y58hIDzZYTGIxjSP
+  3N7uYx5qR8qZvuO4F1McGJ/NES2robjQcV/aIRXD+5RjbokyYYGJlJujm5c/wZme
+  Us7pOzQxc8QcogsdInwQ6O9hTQ4zBdOFZt6YBp5y9ycXVIApBnxJHBU3W6Ir1hl6
+  3v6RYBgHFd3g0dCwuBoaYZE5MU/4q91vc48XhioqXdJlaDyw1ZMyvE+loi+8quVg
+  bpUadC/QUZukABYCu6rS6fiRLffmMy/Db7d8b1fP+J1i4bL5atF4xz8c1BDwc2x1
+  mXJDUBznMSDpmjAkUwDjh+330tYT/VTioqobCMSLfwgJI2Uqrr8H8N9yeSsOMAup
+  nJKnJHXeZPEGAr2LBCcok2KUcdugdYq/0C+ec1bU8BHDDoEOM54rhPKKmCJentO6
+  KJRoJfu0ovQj1/BvSksUUWdvhy6jzXviyQq44GKEwsJix6sdNKEpndVDQGOvHPg5
+  gcakte7KrpK2Udwy+dK+caHJWXOouHPPFfdZWr5U9DkNjtvvQrwQUsMxECoByKYA
+  7wmX3SwzodtuzAPGzxuwkqwy1RtHAfbrFINFBxP35G/f16x2mtwEpqsdS4LE+c0C
+  l3eEQ8xIv3ijKUZek87Uxk7/JH76C3/9tSQeFkt0NkEduHOR1H7RAgMBAAEwDQYJ
+  KoZIhvcNAQELBQADggIBALIBNN7zUhFldUaXWGwv6032ZwM2Sm1U8VF8YaH71NLg
+  FhlcuJ0JLkGlxT0/68acS0EwoqOEgaHyPx8eodjyDv2MuJlWJGXIgHgLD66Tu0VA
+  Wt1sgA823Rl35WVSMqiyoxwsrGFwMtayNrrlpdhB8Ny8CMA2NfKyEJkh4+xlE72a
+  D8Eu8NFr9Tt5lHWXdZBI5BhzhQxPPxeIuw0wZ3+kiwxRie7K4XhKsOIrPmu2i6QV
+  Yl/663wZgWpqrroSnc3PE3lsuTW7quUvayjtqMTU2qrh7i21oB+/Nn+I6gcxYJZb
+  UlK+tvsqoM94U6sFTjw9mDt62MLQGrJtHShS+ZZiGmWj1sKreuwGJnCVDoBk15xa
+  oqlvfvLAMBCqlfrHhvGUfbIMgzb9uXNmCjzYMsQxuIgF6IMis6Kq02NBAR91HPMe
+  2RoY7CdBHMxW+O0tgS2xoQbOwb+ti1j4MbsWpCqS9Mteck0Z7jZpRRrUDjXU+/7Z
+  RmW9HX0oLIoCBDChCcEKG0Ma4IvHUgjv47f5iYpkXuhifiK4xMG/s+T5Euw3Wg9J
+  tzpk/VnZXj7Ek/earx+N/Z+Wtnl2xENm5IF8SFPeI1HFa9NH47pqtxF1YKpNIEVc
+  2xa2BNHSePe7tys/2hbmZuyMu8X5ERmovsabSXB3a+YwtJh5c2jhA21wF7986s0q
+  -----END CERTIFICATE-----
+date: 2018-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '999'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '999'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.7.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.7.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: sixarm_ruby_minitest_extensions
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.8
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.8
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '11'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: sixarm_ruby_active_record_migration_mock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.8
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '999'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.8
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '999'
+description: Migration helper extensions for Ruby On Rails development
+email: sixarm@sixarm.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- lib/sixarm_ruby_migration_helper_extensions.rb
+- test/sixarm_ruby_migration_helper_extensions_test.rb
+homepage: http://sixarm.com/
+licenses:
+- Apache-2.0
+- Artistic-2.0
+- BSD-3-Clause
+- GPL-3.0
+- MIT
+- MPL-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.2'
+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: SixArm.com → Ruby → Migration helper extensions
+test_files:
+- test/sixarm_ruby_migration_helper_extensions_test.rb