cool_id 0.1.3 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a61d8d06c3414dcec52ecd9a3f28696d0fafb683b2b206e025c33a1deb03de9
-  data.tar.gz: bc13a903ed6d5239eae6ee216f5da45699a525d755e914f9f9c2b81b6e33d26c
+  metadata.gz: 0d44c3207248595af232a200cf0e809224d74033d97d3cac52c6d06d5416b682
+  data.tar.gz: d221baeb8e79ea8ea8ca2b9503685e4bfa7cb8d57b53a3ba0e4d301138a08300
 SHA512:
-  metadata.gz: 77aac33c12253962d7beabffc5d7101379f40d991b580c67ea0a306cd82f8d2befda21b23fbd3c3735a516863ef4c3565b18084f67ed001172b7a395527f3f4a
-  data.tar.gz: d3c269343bd10098fdd902424c10c22e676a0cea67d5dff404628863ea4d085319017b31d6c602364da024d36c30a470e1bd3ade7b687379bbbd3f011a72191c
+  metadata.gz: 9ed700560671d811b0678c4fbe8f9e086c3ca0c9e8d04a54b7d40d586b20864e2add65adb9e5e53feb7915e472974dbfa6b31313dd6a64f4008aaf3f31503f70
+  data.tar.gz: df1cdc3098d9b4761a220fedeca362eeaeb5677d92ca7da594dc946223d814c81bb59db757ff08292fe72e3ce499dd95e1cc002ccf27c436aa097617bd14f2a9

data/LICENSE

@@ -0,0 +1,15 @@
+ISC License
+
+Copyright (c) Peter Schilling
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.

data/README.md

@@ -1,31 +1,132 @@
-# CoolId
+# cool_id
 
-TODO: Delete this and the text below, and describe your gem
+a gem for rails that generates string primary key ids for active record models with a per-model prefix followed by a nanoid. this lets you create stripe style ids in your own rails app, and they'll be the same ids you see in your database.
 
-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/cool_id`. To experiment with that code, run `bin/console` for an interactive prompt.
+```ruby
+class User < ActiveRecord::Base
+  include CoolId::Model
+  cool_id prefix: "usr"
+end
 
-## Installation
+User.create!(name: "...").id
+# => "usr_vktd1b5v84lr"
+```
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+it can also lookup records similar to global id:
 
-Install the gem and add to the application's Gemfile by executing:
+```ruby
+CoolId.locate("usr_vktd1b5v84lr")
+# => #<User id: "usr_vktd1b5v84lr", name: "John Doe">
+```
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+and parse ids
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+```ruby
+parsed = CoolId.parse("usr_vktd1b5v84lr")
+# => #<struct CoolId::Id key="vktd1b5v84lr", prefix="usr", id="usr_vktd1b5v84lr", model_class=User>
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+parsed.model_class
+# => User
+```
 
-## Usage
+and generate ids without creating a record
 
-TODO: Write usage instructions here
+```ruby
+# generate an id, e.g. for batch inserts or upserts
+User.generate_cool_id
+# => "usr_vktd1b5v84lr"
 
-## Development
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+it takes parameters to change the alphabet or length
 
-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`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```ruby
+class Customer < ActiveRecord::Base
+  include CoolId::Model
+  cool_id prefix: "cus", alphabet: "ABCDEFGHIJKLMNOPQRSTUVWXYZ", length: 8
+end
 
-## Contributing
+Customer.create!(name: "...").id
+# => "cus_UHNYBINU"
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/cool_id.
+and these can be configured globally
+
+```ruby
+CoolId.configure do |config|
+  config.separator = "-"
+  config.alphabet = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
+  config.length = 8
+end
+```
+
+## installation
+
+add cool_id to your Gemfile:
+
+```bash
+bundle add cool_id
+```
+
+```ruby
+gem "cool_id"
+```
+
+### using cool_id in one model
+
+use string ids when creating a table
+
+```ruby
+create_table :users, id: :string do |t|
+  t.string :name
+end
+```
+
+include the `CoolId::Model` concern in the active record model and set up a prefix
+
+```ruby
+class User < ActiveRecord::Base
+  include CoolId::Model
+  cool_id prefix: "usr"
+end
+```
+
+### using cool_id on all models
+
+you have drank the coolaid. setup rails to use string ids on all new generated migrations
+
+```ruby
+# config/initializers/generators.rb
+Rails.application.config.generators do |g|
+  g.orm :active_record, primary_key_type: :string
+end
+```
+
+then setup `ApplicationRecord` to include cool id and ensure it's setup in classes that inherit from it
+
+```ruby
+# app/models/application_record.rb
+class ApplicationRecord < ActiveRecord::Base
+  include CoolId::Model
+  primary_abstract_class
+  enforce_cool_id_for_descendants
+end
+```
+
+### graphql
+
+if you use the graphql ruby node interface, you can implement [object identification](https://graphql-ruby.org/schema/object_identification)
+
+
+```ruby
+# app/graphql/app_schema.rb
+class AppSchema < GraphQL::Schema
+  def self.id_from_object(object, type_definition, query_ctx)
+    object.id
+  end
+
+  def self.object_from_id(id, query_ctx)
+    CoolId.locate(id)
+  end
+end
+```

data/lib/cool_id/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CoolId
-  VERSION = "0.1.3"
+  VERSION = "0.1.6"
 end

data/lib/cool_id.rb

@@ -106,11 +106,11 @@ module CoolId
         CoolId.generate_id(@cool_id_config)
       end
 
-      def ensure_cool_id_setup
+      def enforce_cool_id_for_descendants
         @cool_id_setup_required = true
       end
 
-      def skip_cool_id_setup
+      def skip_enforce_cool_id_for_descendants
         @cool_id_setup_required = false
       end
 
@@ -134,7 +134,7 @@ module CoolId
 
       def ensure_cool_id_configured
         if self.class.cool_id_setup_required && self.class.cool_id_config.nil?
-          raise Error, "CoolId not configured for #{self.class}. Use 'cool_id' to configure or 'skip_cool_id_setup' to opt out."
+          raise Error, "CoolId not configured for #{self.class}. Use 'cool_id' to configure or 'skip_enforce_cool_id_for_descendants' to opt out."
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cool_id
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.6
 platform: ruby
 authors:
 - Peter Schilling
@@ -76,13 +76,15 @@ files:
 - ".rspec"
 - ".standard.yml"
 - CHANGELOG.md
+- LICENSE
 - README.md
 - Rakefile
 - lib/cool_id.rb
 - lib/cool_id/version.rb
 - sig/cool_id.rbs
 homepage: https://github.com/schpet/cool_id
-licenses: []
+licenses:
+- ISC
 metadata:
   homepage_uri: https://github.com/schpet/cool_id
   source_code_uri: https://github.com/schpet/cool_id