activerecord-propertybase_id 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4482c6bf93ce91a8badf8882964dcc5884dda017
+  data.tar.gz: b19fec208329f02aa6c4a400a779b2b66432bb75
+SHA512:
+  metadata.gz: d798f4c99982ecaa66efa91d32b785af144d7bedce6a9ec7e69a03bedb5eed898153077a30e58beab2a3fd396921d8c2f953b765daa753047c10a882f8c316fa
+  data.tar.gz: 4239c047ad3058046e810bce8aee9d865c8099c1b1d807716590d8223dc489ec9ad153acc65223128b53d109a6b98872a53be95fd79ed547e93f6564ff9b3356

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/spec/debug.log
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,24 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.1.5
+  - 2.2.1
+  - rbx
+  - ruby-head
+  - jruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+matrix:
+  fast_finish: true
+addons:
+  postgresql: "9.4"
+env:
+  - DB=sqlite3
+  - DB=postgresql
+script:
+    - bundle exec rspec
+before_script:
+    - gem update bundler
+    - psql -c 'create database propertybase_id_test;' -U postgres

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers 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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in activerecord-propertybase_id.gemspec
+gemspec
+
+gem "guard"
+gem "guard-rspec"

data/Guardfile

@@ -0,0 +1,19 @@
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Standard RubyGem Project
+  watch(/^spec\/.+_spec\.rb/)
+  watch(/^lib\/(.+)\.rb/)     { |m| "spec/#{m[1]}_spec.rb" }
+  watch("spec/spec_helper.rb")  { "spec" }
+end

data/README.md

@@ -0,0 +1,88 @@
+# ActiveRecord::PropertybaseId
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/activerecord/propertybase_id`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "activerecord-propertybase_id"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord-propertybase_id
+
+## Usage
+
+This ActiveRecord extension lets you use the [Propertybase ID](https://github.com/propertybase/propertybase_id) as a primary key in Rails.
+
+### Migration
+
+The Propertybase ID is stored via the `char(8)` data type (currently only tested on SQLite and PostgreSQL). You can also use the cusom migration type `propertybase_id`.
+
+Note: As Rails doesn't really support changing the type of the primary key in the migration. You need to work around a little bit. You need to disable the ID for a sepcific table and then add it as
+
+```ruby
+class CreateTeams < ActiveRecord::Migration
+  def change
+    create_table :teams, id: false do |t|
+      t.propertybase_id :id, primary_key: true
+
+      t.string :name
+      t.timestamps null: false
+    end
+  end
+end
+```
+
+You are now all set to use the Propertybase ID as the primary key of your table.
+
+### ActiveRecord Models
+
+To make sure the ID is generated, you need to include the `ActiveRecord::PropertybaseId` module:
+
+```ruby
+class Team < ActiveRecord::Base
+  include ActiveRecord::PropertybaseId
+end
+```
+
+The PropertybaseId need the object type as input. By default the object type will be inferred by the model name (currently only Team and User working), but you override it by specifying `propertybase_object`
+
+```ruby
+class CustomizedUser < ActiveRecord::Base
+  include ActiveRecord::PropertybaseId
+
+  propertybase_object :user
+end
+```
+
+## Caveats
+
+Currently this gem only has been tested on PostgreSQL and SQLite and Rails version 4.2
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Atribution
+
+Heavily inspired by [activeuuid](https://github.com/jashmenn/activeuuid).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/activerecord-propertybase_id/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/activerecord-propertybase_id.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "activerecord/propertybase_id/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "activerecord-propertybase_id"
+  spec.version       = ActiveRecord::PropertybaseId::VERSION
+  spec.authors       = ["Leif Gensert"]
+  spec.email         = ["leif@propertybase.com"]
+
+  spec.summary       = %q{Propertybase ID for ActiveRecord}
+  spec.description   = %q{Use the propertybase_id as the primary key in all your rails models}
+  spec.homepage      = "http://www.propertybase.com"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "propertybase_id", ">= 0.3.3"
+  spec.add_dependency "activerecord", ">= 4.2", "< 4.3"
+
+  spec.add_development_dependency "bundler", "< 1.10"
+  spec.add_development_dependency "rake", "< 11.0"
+  spec.add_development_dependency "rspec", "< 3.3"
+  if defined?(JRUBY_VERSION)
+    spec.add_development_dependency "activerecord-jdbc-adapter", "< 1.4"
+    spec.add_development_dependency "jdbc-postgres", "< 9.5"
+    spec.add_development_dependency "jdbc-sqlite3", "< 3.9"
+  else
+    spec.add_development_dependency "pg", "< 0.19"
+    spec.add_development_dependency "sqlite3", "< 1.4.0"
+  end
+  spec.add_development_dependency "database_cleaner", "< 1.5.0"
+  spec.add_development_dependency "rspec-its", "< 1.3.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "activerecord/propertybase_id"
+
+# 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

data/bin/setup

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

data/lib/activerecord/propertybase_id.rb

@@ -0,0 +1,41 @@
+require "propertybase_id"
+require "active_record"
+require "active_support/concern"
+require "activerecord/propertybase_id/version"
+require "activerecord/propertybase_id/patches"
+require "activerecord/propertybase_id/railtie" if defined?(Rails::Railtie)
+
+module ActiveRecord
+  module PropertybaseId
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :_propertybase_object, instance_writer: false
+      self._propertybase_object = self.name.underscore
+
+      before_create :generate_propertybase_id_if_needed
+    end
+
+    def propertybase_id
+      pb_id_string = send(self.class.primary_key)
+      ::PropertybaseId.parse(pb_id_string)
+    end
+
+    def generate_propertybase_id
+      ::PropertybaseId.generate(object: _propertybase_object.to_s).to_s
+    end
+
+    def generate_propertybase_id_if_needed
+      primary_key = self.class.primary_key
+      send("#{primary_key}=", generate_propertybase_id) unless send("#{primary_key}?")
+    end
+
+    module ClassMethods
+      def propertybase_object(proeprtybase_object)
+        self._propertybase_object = proeprtybase_object
+      end
+    end
+  end
+end
+
+ActiveRecord::PropertybaseId::Patches.apply!

data/lib/activerecord/propertybase_id/patches.rb

@@ -0,0 +1,21 @@
+module ActiveRecord
+  module PropertybaseId
+    module Patches
+      module Migrations
+        def propertybase_id(*column_names)
+          options = column_names.extract_options!
+          column_names.each do |name|
+            type = "char(#{::PropertybaseId.max_length})"
+            primary_key = options.delete(:primary_key) || name.to_s == "id"
+            column(name, "#{type}#{' PRIMARY KEY' if primary_key}", options)
+          end
+        end
+      end
+
+      def self.apply!
+        ActiveRecord::ConnectionAdapters::Table.send :include, Migrations if defined? ActiveRecord::ConnectionAdapters::Table
+        ActiveRecord::ConnectionAdapters::TableDefinition.send :include, Migrations if defined? ActiveRecord::ConnectionAdapters::TableDefinition
+      end
+    end
+  end
+end

data/lib/activerecord/propertybase_id/railtie.rb

@@ -0,0 +1,14 @@
+require "activerecord/propertybase_id"
+require "rails"
+
+module ActiveRecord
+  module PropertybaseId
+    class Railtie < Rails::Railtie
+      railtie_name :propertybase_id
+
+      config.to_prepare do
+        ActiveRecord::PropertybaseId::Patches.apply!
+      end
+    end
+  end
+end

data/lib/activerecord/propertybase_id/version.rb

@@ -0,0 +1,5 @@
+module ActiveRecord
+  module PropertybaseId
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,190 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-propertybase_id
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Leif Gensert
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: propertybase_id
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.3
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '11.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: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+description: Use the propertybase_id as the primary key in all your rails models
+email:
+- leif@propertybase.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- activerecord-propertybase_id.gemspec
+- bin/console
+- bin/setup
+- lib/activerecord/propertybase_id.rb
+- lib/activerecord/propertybase_id/patches.rb
+- lib/activerecord/propertybase_id/railtie.rb
+- lib/activerecord/propertybase_id/version.rb
+homepage: http://www.propertybase.com
+licenses: []
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Propertybase ID for ActiveRecord
+test_files: []