public_id 0.5.0 → 1.0.0

data/README.md

@@ -24,7 +24,7 @@ rails generate migration add_ident_to_users ident:string
 Tell your activerecord object that ident is your new public identifier.
 ```ruby
 class User < ActiveRecord::Base
-  publically_identified_by :ident
+  has_public_id :ident
   # Automatically defines to_param as :ident
 end
 User.new.ident
@@ -56,7 +56,7 @@ There's a few other convenience methods that you may find useful.
 
   * Get a new random ID for your own nefarious purposes:
 
-  ``` User.new_public_identifier ```
+  ``` User.new_public_id ```
 
 ### Configuration
 
@@ -66,11 +66,11 @@ The suffix and prefix are joined by a dash.
 
 You can skip the prefix alltogether:
 ```ruby
-  publically_identified_by column_name, length: 10, prefix: false
+  has_public_id column_name, length: 10, prefix: false
 ```
 or set it directly:
 ```
-  publically_identified_by other_column_name, length: 15, prefix: 'user_'
+  has_public_id other_column_name, length: 15, prefix: 'user_'
 ```
 The "length" option refers to the length argument passed to SecureRandom. The actual length
 of the random base64 string will be about 4/3's this length. The defaults to 10, for a

data/lib/public_id/activerecord/has_public_id.rb

@@ -0,0 +1,55 @@
+module PublicId
+  module ActiveRecord
+    module InstanceMethods
+      def to_param
+        self.send(public_id_attr)
+      end
+      def public_id_attr
+        self.class.public_id_attr
+      end
+      def initialize_public_id
+        self.send(public_id_attr) or
+        self.send("#{public_id_attr}=", self.class.new_public_id)
+      end
+    end
+    module PublicallyIdentifiedBy
+      extend ActiveSupport::Concern
+      included do
+      end
+      module ClassMethods
+        def has_public_id(attribute_name, *args)
+          return if respond_to?(:public_id_attribute)
+          options = args.extract_options!
+          class << self
+            attr_accessor :public_id_attr, :public_id_options
+            # def public_identifier
+            #   @public_identifier
+            # end
+            # def public_identifier=(attribute_name)
+            #   @public_identifier = attribute_name
+            # end
+            def initialize_public_ids!
+              self.where(self.public_id_attr => nil).find_each do |obj|
+                obj.update_attribute(self.public_id_attr, self.new_public_id)
+              end
+            end
+            def find_by_public_id(public_id)
+              where(self.public_id_attr => public_id).first
+            end
+            def new_public_id
+              while(true)
+                new_id = ::PublicId::Util.new_public_id(self, self.public_id_options)
+                break unless where(self.public_id_attr => new_id).exists?
+              end
+              return new_id
+            end
+          end
+          self.public_id_attr     = attribute_name
+          self.public_id_options  = options
+          include ::PublicId::ActiveRecord::InstanceMethods
+          after_initialize :initialize_public_id
+        end
+      end
+    end
+  end
+end

data/lib/public_id/util.rb

@@ -6,7 +6,7 @@ module PublicId
     def self.generate_prefix(klass, joiner)
       klass.to_s.demodulize.underscore.first(3) + joiner
     end
-    def self.new_public_identifier(klass, options = {})
+    def self.new_public_id(klass, options = {})
       length = options[:length] || 10
       prefix = options.fetch(:prefix, generate_prefix(klass, options.fetch(:joiner, '-') ))
       suffix = generate_random_suffix(length)

data/lib/public_id/version.rb

@@ -1,3 +1,3 @@
 module PublicId
-  VERSION = "0.5.0"
+  VERSION = "1.0.0"
 end

data/test/dummy/app/models/user.rb

@@ -1,3 +1,3 @@
 class User < ActiveRecord::Base
-  publically_identified_by :ident
+  has_public_id :ident
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: public_id
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -52,7 +52,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/public_id/activerecord/publically_identified_by.rb
+- lib/public_id/activerecord/has_public_id.rb
 - lib/public_id/util.rb
 - lib/public_id/version.rb
 - lib/public_id.rb

data/lib/public_id/activerecord/publically_identified_by.rb

@@ -1,55 +0,0 @@
-module PublicId
-  module ActiveRecord
-    module InstanceMethods
-      def to_param
-        self.send(self.class.public_identifier_attribute)
-      end
-      def public_identifier_attribute
-        self.class.public_identifier_attribute
-      end
-      def initialize_public_id
-        self.send(public_identifier_attribute) or
-        self.send("#{public_identifier_attribute}=", self.class.new_public_identifier)
-      end
-    end
-    module PublicallyIdentifiedBy
-      extend ActiveSupport::Concern
-      included do
-      end
-      module ClassMethods
-        def publically_identified_by(attribute_name, *args)
-          return if respond_to?(:public_identifier_attribute)
-          options = args.extract_options!
-          class << self
-            attr_accessor :public_identifier_attribute, :public_identifier_options
-            # def public_identifier
-            #   @public_identifier
-            # end
-            # def public_identifier=(attribute_name)
-            #   @public_identifier = attribute_name
-            # end
-            def initialize_public_ids!
-              self.where(self.public_identifier_attribute => nil).find_each do |obj|
-                obj.update_attribute(self.public_identifier_attribute, self.new_public_identifier)
-              end
-            end
-            def find_by_public_id(public_id)
-              where(self.public_identifier_attribute => public_id).first
-            end
-            def new_public_identifier
-              while(true)
-                new_id = ::PublicId::Util.new_public_identifier(self, self.public_identifier_options)
-                break unless where(self.public_identifier_attribute => new_id).exists?
-              end
-              return new_id
-            end
-          end
-          self.public_identifier_attribute = attribute_name
-          self.public_identifier_options = options
-          include ::PublicId::ActiveRecord::InstanceMethods
-          after_initialize :initialize_public_id
-        end
-      end
-    end
-  end
-end