autoguid 1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NDRlNzVkZjBkZGQ2ODUzNDlhMWVkZjM0ZDk3NzFkZTg1YWU1NzY3ZQ==
+  data.tar.gz: !binary |-
+    Y2E3MDA0NzEzYzM3M2ZjMGI0NThiMWFjMmViZTc4ZGU4OGI4ZDIwMw==
+SHA512:
+  metadata.gz: !binary |-
+    YmZjODdkNzU4MWM3NjA0YTMxOTk5ZDBiMDdjOGU5ZjVjMDY1MDQ4NWYxYTcy
+    NjgwNjRiNGNjNTk0OTU3NmRhMDg0MjExM2Q2YmE3ZmU4NDdkZDQ0M2U3NTU5
+    ZjVlMzA0MjBkOTdjOWExYTk1YTRiNTRhYWNhNDgxNGFmYmFhYmU=
+  data.tar.gz: !binary |-
+    M2YwOTVkMDAzYjc1Mjc2ZTM3NzNkYjRhMWYzYWNhNzczMDA3OTdlYTI3NTVk
+    M2RhYWM2NTE0MzhmMDlhNTk5OWFlMDlkOWQ1ZWY1YjQxNTQ3Y2JmZGNlZDI2
+    OTU0MmNjMjJiZTg4MDYxYjRjZjViMTk0MWJkMGM2MDQ5MzA5MzE=

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+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.rdoc

@@ -0,0 +1,16 @@
+= Autoguid
+
+This project rocks and uses MIT-LICENSE.
+
+Autoguid lets you trivially add human readable uuids to all
+your models, a whitelisted set of models, or all but a blacklisted set.
+Indices are automatically created based on a configuration option.
+There's also a rake task that will backfill these uuids into resources that
+have already been created.
+To get started, include the gem file, run `bundle install`, then run
+`rake autoguid:install`. From there, edit the config/initializers/autoguid.rb
+file to specify your configuration. Next, migrate your tables with
+`rake autoguid:migrate:up` and `rake autoguid:migrate:backfill` as required.
+`rake autoguid:migrate:drop_all` will drop all autoguid generated columns and
+the data in them. You can always change the config/initializers/autoguid.rb file
+and rerun `rake autoguid:migrate:up` to add autoguid to new models.

data/Rakefile

@@ -0,0 +1,30 @@
+begin
+  require 'bundler/setup'
+  require 'rspec/core/rake_task'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Autoguid'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+# Default directory to look in is /specs
+RSpec::Core::RakeTask.new(:test) do |task|
+  #task.rspec_opts = ['--color', '--format', 'nested']
+  # task.rspec_opts = '--tag'
+end
+
+
+task default: :test

data/lib/autoguid.rb

@@ -0,0 +1,30 @@
+require 'railtie' if defined?(Rails)
+
+module Autoguid
+  extend ActiveSupport::Concern
+
+    included do
+      before_create do
+        save_autoguid( generate_autoguid )
+      end
+    end
+
+    def save_autoguid(guid)
+      self.guid = guid
+    end
+
+    def generate_autoguid
+      uuid = SecureRandom.uuid
+      name = self.is_a?(Module) ? name : self.class.name
+      return name + '-' + uuid
+    end
+
+    def backfill(model)
+      puts "Backfilling " + model
+      model.all.each do |row|
+        puts "Found a row"
+        row.guid = generate_autoguid
+        row.save
+      end
+    end
+end

data/lib/autoguid/version.rb

@@ -0,0 +1,3 @@
+module Autoguid
+  VERSION = "1.0"
+end

data/lib/initializer.rb

@@ -0,0 +1,37 @@
+require 'migrator'
+require 'autoguid'
+
+class Initializer
+
+	def config
+		@migrator = Migrator.new
+		@migrator.config = Hash.new
+
+    # To configure autoguid you need to edit this file. Uncomment ONE
+    # of the following three lines based on your needs.
+
+    # Uncomment this line to add autoguids to all of your models
+		# @migrator.config[:all] = true
+
+    # Uncomment this line to whitelist models that you want autoguids on
+    # They will be added only to the resources listed
+		# @migrator.config[:whitelist] = ['User','Office']
+
+    # Uncomment this line to blacklist the models you dont want autoguids on
+    # They will be added to all other models
+		# @migrator.config[:blacklist] = ['User']
+
+    # Uncomment this line to add indices to your autoguid generated columns
+    # This will speed up lookups but occupy some database server memory
+		# @migrator.config[:indices] = true
+	end
+
+	def up
+		@migrator.up
+	end
+
+	def drop_all
+		@migrator.down
+	end
+
+end

data/lib/migrator.rb

@@ -0,0 +1,45 @@
+class Migrator < ActiveRecord::Migration
+
+    attr_accessor :config
+
+    def up
+      puts config
+      Rails.application.eager_load!
+      models = Array.new
+      whitelist = Array.new
+      if ( @config[:all] )
+        whitelist = ActiveRecord::Base.direct_descendants if @config[:all]
+      elsif ( @config[:whitelist] )
+        puts "Got into Whitelist"
+        models = ActiveRecord::Base.direct_descendants
+        models.each do |m|
+          puts "Checking for model " + m.name + " in whitelist "
+          whitelist.push(m) if @config[:whitelist].include?(m.name)
+        end
+      elsif ( @config[:blacklist] )
+        puts "Processing by blacklist"
+        whitelist = ActiveRecord::Base.direct_descendants
+        whitelist.each do |m|
+          puts "Checking for model " + m.name + " in blacklist "
+          whitelist.delete(m) if @config[:blacklist].include?(m.name)
+        end
+      end
+      puts whitelist
+      whitelist.each do |model|
+        puts "Processing " + model.name
+        model.reset_column_information
+        add_column(model, :guid, :string, :unique => true) unless column_exists?(model, :guid)
+        add_index(model, :guid) if @config[:indices] && !index_exists?(model, :guid)
+      end
+    end
+
+    def down
+      Rails.application.eager_load!
+      ActiveRecord::Base.direct_descendants.each do |model|
+        model.reset_column_information
+        remove_index(model, :guid) if index_exists?(model, :guid)
+        remove_column(model, :guid) if column_exists?(model, :guid)
+      end
+    end
+
+end

data/lib/railtie.rb

@@ -0,0 +1,10 @@
+require 'autoguid'
+require 'rails'
+
+module Autoguid
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load "tasks/autoguid_tasks.rake"
+    end
+  end
+end

data/lib/tasks/autoguid_tasks.rake

@@ -0,0 +1,32 @@
+namespace :autoguid do
+	task :install do
+    path = Rails.root.to_s + "/config/initializers/autoguid.rb"
+    template_path = File.expand_path('../../initializer.rb',__FILE__)
+    template = File.open(template_path)
+    File.open(path, "w") do |f|
+      IO.copy_stream(template,f)
+    end
+	end
+  namespace :migrate do
+    task :up => :environment do
+      init = Initializer.new
+      init.config
+      init.up
+    end
+    task :drop_all => :environment do
+      init = Initializer.new
+      init.config
+      init.drop_all
+    end
+    task :backfill => :environment do
+      require 'autoguid'
+      Rails.application.eager_load!
+      ActiveRecord::Base.direct_descendants.each do |model|
+        puts model
+        model.reset_column_information
+        Autoguid.backfill(model) if model.columns_hash['guid']
+      end
+    end
+  end
+
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: autoguid
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Peter Kinnaird
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.1.4
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 4.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.1.4
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 4.1.4
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.9
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.9
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.9
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.9
+description: ! "Autoguid lets you trivially add human readable uuids to all\n   your
+  models, a whitelisted set of models, or a blacklisted set.\n   Indices are automatically
+  created based on a configuration option.\n   There's also a rake task that will
+  backfill these uuids into resources that\n   have already been created.\n   To get
+  started, include the gem file, run `bundle install`, then run\n   `rake autoguid:install`.
+  From there, edit the config/initializers/autoguid.rb\n   file to specifcy your configuration.
+  Next, migrate your tables with\n   `rake autoguid:migrate:up` and `rake autoguid:migrate:backfill`
+  as required.\n   `rake autoguid:migrate:drop_all` will drop all autoguid generated
+  columns and\n   the data in them. You can always change the config/initializers/autoguid.rb
+  file\n   and rerun `rake autoguid:migrate:up` to add autoguid to new models."
+email:
+- peter@hacktivism.cc
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- lib/autoguid.rb
+- lib/autoguid/version.rb
+- lib/initializer.rb
+- lib/migrator.rb
+- lib/railtie.rb
+- lib/tasks/autoguid_tasks.rake
+homepage: http://hacktivism.cc
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Autoguid adds human readable uuids to your models
+test_files: []