toolx 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f027d545a91be1a02f8ef28f52ced20c6d6ffe3defc99be3f59dd783b78bed2f
-  data.tar.gz: 453e20a3f42da721d4acdb50fb62de95ad62b4801c6c652c3285c8a5de311a21
+  metadata.gz: 6fc01244224cb4f82dd203b789591041faf4d0e155236d2aa68a1f6df3b418d8
+  data.tar.gz: 77e069e564822a8a91050bac2bba8b3e76d4c36c460852fa29219af9e7c4a32c
 SHA512:
-  metadata.gz: 9551fd33fe000bf1a10e5500a409f770ea64533b3db892825174f96659773fa93b872b78f21cb7dbdfc575045e54024bddb18e499b96417c36a1edf0a931a3b4
-  data.tar.gz: '018ed1cadf76d903502d6e1b5fdd1c3bc14d3891995d35d2566fb36c2c15ffbd59ea04c6af87d46f7c876cbf840a5f903b3b2eae8b6d43e3afafa3738ee74de1'
+  metadata.gz: b6cf65409dfd5aebac40a2ce888ebc2cd71d426849df88624323d6a7dc8f2c6dd25317852d320dee7036930841dd3bc8d92584af7b5607dfb78b2104252d1d6b
+  data.tar.gz: 1c67d81bd13da36a9e3c745939f006119fdf8f03449cdf069fada40901b9e460c054b77979d1d79d907eb42b01073756fa0336c3fe3c2b258d77a837a18d8986

data/README.md

@@ -26,6 +26,8 @@ class ApplicationRecord < ActiveRecord::Base
   include Toolx::Core::Concerns::Transformer
   include Toolx::Core::Concerns::CustomIdentifier
   include Toolx::Core::Concerns::DateTimeToBoolean
+  include Toolx::Core::Concerns::Keygen
+  include Toolx::Core::Concerns::Tokenizer
   include Toolx::Core::Concerns::WithStateMachine
 end
 ```
@@ -135,6 +137,96 @@ user.deleted = true  # also sets current time
 user.deleted = false # sets deleted_at to nil
 ```
 
+### Keygen
+
+Generate unique keys for your models, ensuring they are unique across the database.
+
+```ruby
+class User < ApplicationRecord
+  include Toolx::Core::Concerns::Keygen
+
+  keygen :dob, attr: :lic_key, secret: 'my$ecret', limit: 20, separator: '.', br: 3
+end
+user = User.new(dob: '1990-01-01')
+user.save! 
+user.lic_key # => '090.cc2.207.c45.3e7.20b.f95'
+```
+
+### Tokenizer
+
+Generate unique tokens for your models before creation, useful for API keys, access tokens, invitations, etc.
+
+```ruby
+class AccessToken < ApplicationRecord
+  include Toolx::Core::Concerns::Tokenizer
+
+  tokenize :token, size: 32, prefix: 'tok'
+end
+
+token = AccessToken.create!
+token.token # => "tok-xnT3yM9dPQsA4W8Ks7LZhV5RuKcgByTw"
+```
+
+### Stateman via with_state_machine 
+
+It is working only with `Statesman::Adapters::ActiveRecord`
+
+You can generate state machine classes via rake task
+
+```bash
+bin/rails "toolx:stateman:generate[Project]"
+```
+command will generate models for existing `Project` model as
+`Project::StateMachine` and `Project::Transition`.
+
+also will add migraion file for those models.
+
+Example usage:
+
+```ruby
+class Project::StateMachine
+  include Statesman::Machine
+
+  state :active, initial: true
+  state :pending
+  state :skipped
+  state :cancelled
+  state :done
+
+  transition from: :active, to: [:pending, :pending, :skipped, :cancelled, :done]
+  transition from: :pending, to: [:skipped, :cancelled, :done]
+  transition from: :skipped, to: [:pending]
+
+  after_transition do |model, transition|
+    model.update!(status: transition.to_state)
+  end
+end
+
+class Project::Transition < ActiveRecord::Base
+  belongs_to :project
+
+  attribute :most_recent, :boolean, default: false
+  attribute :sort_key, :integer
+  attribute :to_state, :string
+  attribute :metadata, :json, default: {}
+
+  validates :to_state, inclusion: { in: Project::StateMachine.states }
+end
+
+class Project < ActiveRecord::Base
+  include Toolx::Core::Concerns::WithStateMachine
+  STATUSES = %w[active pending done skipped cancelled].freeze
+
+  with_state_machine
+
+  attribute :name, :string
+  attribute :status, :string, default: 'active'
+
+  validates :name, presence: true
+  validates :status, inclusion: { in: STATUSES }, allow_nil: true
+end
+```
+
 ### Errors
 
 A structured, extensible error-handling framework:
@@ -227,7 +319,6 @@ end
 Presenter.auto_present(Article.new(title: "A very long title"))
 ```
 
-
 ### SimpleCrypt
 
 Simple AES encryption helper using ActiveSupport::MessageEncryptor.
@@ -383,66 +474,6 @@ SignupOperation.flow
   .perform!(email: 'foo@bar.com', age: 20)
 ```
 
-### Stateman via with_state_machine 
-
-It is working only with `Statesman::Adapters::ActiveRecord`
-
-You can generate state machine classes via rake task
-
-```bash
-bin/rails "toolx:stateman:generate[Project]"
-```
-command will generate models for existing `Project` model as
-`Project::StateMachine` and `Project::Transition`.
-
-also will add migraion file for those models.
-
-Example usage:
-
-```ruby
-class Project::StateMachine
-  include Statesman::Machine
-
-  state :active, initial: true
-  state :pending
-  state :skipped
-  state :cancelled
-  state :done
-
-  transition from: :active, to: [:pending, :pending, :skipped, :cancelled, :done]
-  transition from: :pending, to: [:skipped, :cancelled, :done]
-  transition from: :skipped, to: [:pending]
-
-  after_transition do |model, transition|
-    model.update!(status: transition.to_state)
-  end
-end
-
-class Project::Transition < ActiveRecord::Base
-  belongs_to :project
-
-  attribute :most_recent, :boolean, default: false
-  attribute :sort_key, :integer
-  attribute :to_state, :string
-  attribute :metadata, :json, default: {}
-
-  validates :to_state, inclusion: { in: Project::StateMachine.states }
-end
-
-class Project < ActiveRecord::Base
-  include Toolx::Core::Concerns::WithStateMachine
-  STATUSES = %w[active pending done skipped cancelled].freeze
-
-  with_state_machine
-
-  attribute :name, :string
-  attribute :status, :string, default: 'active'
-
-  validates :name, presence: true
-  validates :status, inclusion: { in: STATUSES }, allow_nil: true
-end
-```
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/tasks/aliases.rake

@@ -2,7 +2,7 @@ namespace :toolx do
   namespace :aliases do
     desc 'Generate toolx_aliases.rb'
     task :generate do
-      file_name = Rails.root.join('lib', 'toolx_aliases.rb')
+      file_name = Rails.root.join('config', 'initializers', 'toolx_aliases.rb')
       return if File.exist?(file_name)
 
       File.open(file_name, 'w') do |file|
@@ -14,6 +14,8 @@ namespace :toolx do
           # DateTimeToBoolean = Toolx::Core::Concerns::DateTimeToBoolean
           # CustomIdentifier = Toolx::Core::Concerns::CustomIdentifier
           # Transformer = Toolx::Core::Concerns::Transformer
+          # Keygen = Toolx::Core::Concerns::Keygen
+          # Tokenizer = Toolx::Core::Concerns::Tokenizer 
           
           NestedError = Toolx::Core::Errors::NestedError
           NestedStandardError = Toolx::Core::Errors::NestedStandardError
@@ -40,11 +42,13 @@ namespace :toolx do
           include Toolx::Core::Concerns::CustomIdentifier
           include Toolx::Core::Concerns::DateTimeToBoolean
           include Toolx::Core::Concerns::WithStateMachine
+          include Toolx::Core::Concerns::Keygen
+          include Toolx::Core::Concerns::Tokenizer
         end
       RUBY
       puts "\n"
       puts "Add line below to config/application.rb"
-      puts "require_relative '../lib/toolx_aliases'"
+      puts "require_relative 'initializers/toolx_aliases'"
     end
   end
 end

data/lib/tasks/annotate_rb.rake

@@ -3,7 +3,14 @@ namespace :toolx do
     desc 'Generate annotate rake tasks'
     task :generate do
       file_name = Rails.root.join('lib', 'tasks', 'annotate_rb.rake')
-      return if File.exist?(file_name)
+      next puts "Already executed" if File.exist?(file_name)
+
+      template_root_path = File.expand_path("../templates", __dir__)
+      config_name = '.annotaterb.yml'
+      basic_configuration = File.read(File.join(template_root_path, config_name), trim_mode: '-')
+      File.write(Rails.root.join(config_name).to_s, basic_configuration)
+
+      puts "Basic configuration for annotate_rb gem created at #{config_name}"
 
       File.open(file_name, 'w') do |file|
         file.write <<~RUBY

data/lib/templates/.annotaterb.yml

@@ -0,0 +1,58 @@
+---
+:position: before
+:position_in_additional_file_patterns: before
+:position_in_class: after
+:position_in_factory: after
+:position_in_fixture: after
+:position_in_routes: after
+:position_in_serializer: after
+:position_in_test: after
+:classified_sort: true
+:exclude_controllers: true
+:exclude_factories: false
+:exclude_fixtures: true
+:exclude_helpers: true
+:exclude_scaffolds: true
+:exclude_serializers: false
+:exclude_sti_subclasses: false
+:exclude_tests: true
+:force: false
+:format_markdown: false
+:format_rdoc: false
+:format_yard: false
+:frozen: false
+:ignore_model_sub_dir: false
+:ignore_unknown_models: false
+:include_version: false
+:show_check_constraints: false
+:show_complete_foreign_keys: false
+:show_foreign_keys: true
+:show_indexes: true
+:simple_indexes: false
+:sort: true
+:timestamp: false
+:trace: false
+:with_comment: true
+:with_column_comments: true
+:with_table_comments: true
+:active_admin: false
+:command:
+:debug: false
+:hide_default_column_types: ''
+:hide_limit_column_types: ''
+:ignore_columns:
+:ignore_routes:
+:models: true
+:routes: false
+:skip_on_db_migrate: false
+:target_action: :do_annotations
+:wrapper:
+:wrapper_close:
+:wrapper_open:
+:classes_default_to_s: []
+:additional_file_patterns: []
+:model_dir:
+- app/models
+:require: []
+:root_dir:
+- ''

data/lib/toolx/core/concerns/keygen.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Toolx
+  module Core
+    module Concerns
+      module Keygen
+        extend ::ActiveSupport::Concern
+
+        class_methods do
+          # Generates a unique key based on the provided attributes and an optional secret.
+          # @example
+          #   class License < ApplicationRecord
+          #     include Keygen
+          #     keygen ->(m) { [m.id, m.format_date(m.expire_at), m.type, m.user_id] }
+          #   end
+          #
+          #   license = License.new(id: '1234', expire_at: Time.current + 1.month, type: 'default', user_id: 'usr_5678')
+          #   license.key # => "7034-d544-f8d1-fddf-d939-14ce-53c5-3ed9-f71f-3dab"
+          #
+          # @param source [Array<Symbol, Proc>] Attributes or a Proc to generate the key from.
+          # @param attr [Symbol] The attribute to store the generated key in (default)
+          # @param secret [String, nil] An optional secret to include in the key generation.
+          # @param limit [Integer] The maximum length of the generated key (default: 40).
+          # @param separator [String] The separator to use in the generated key (default: '-').
+          # @param br [Integer] The number of characters in each segment of the key (default: 4).
+          def keygen(*source, attr: :key, secret: nil, limit: 40, separator: '-', br: 4)
+            after_save do
+              next if source.blank?
+
+              binding = source.first.class == Proc
+              data = binding ? source.first.call(self) : source.map { |attr| send(attr).to_s }
+              value = (data.push(secret.to_s)).compact.join
+              result = Digest::SHA256.hexdigest(value)[0..limit].scan(/.{#{br}}/).join(separator)
+
+              next if send(attr) == result
+
+              update_column(attr, result)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/toolx/core/concerns/tokenizer.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Toolx
+  module Core
+    module Concerns
+      module Tokenizer
+        extend ::ActiveSupport::Concern
+
+        class_methods do
+          # Generates a unique token for a given attribute before creation.
+          #
+          # @example
+          #   class AccessToken < ApplicationRecord
+          #     include Toolx::Core::Concerns::Tokenizer
+          #     tokenize :token, size: 32, prefix: 'tok'
+          #   end
+          #
+          #   token = AccessToken.create
+          #   token.token # => "tok-MH3yTbcuZJ8o..."
+          #
+          # @param attribute [Symbol] The attribute to assign the token to.
+          # @param size [Integer] The size of the randomly generated token (default: 64).
+          # @param prefix [String, nil] Optional prefix to prepend to the token.
+          def tokenize(attribute, size: 64, prefix: nil)
+            before_create do
+              token_value = send(attribute)
+              next unless token_value.nil?
+
+              loop do
+                unique = SecureRandom.base58(size)
+
+                send("#{attribute}=", [prefix, unique].compact.join('-'))
+                break unless self.class.exists?(token_value)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/toolx/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Toolx
-  VERSION = '0.1.0'
+  VERSION = '0.2.1'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: toolx
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Pawel Niemczyk
 bindir: exe
 cert_chain: []
-date: 2025-06-24 00:00:00.000000000 Z
+date: 2025-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: statesman
@@ -281,6 +281,7 @@ files:
 - lib/tasks/aliases.rake
 - lib/tasks/annotate_rb.rake
 - lib/tasks/stateman.rake
+- lib/templates/.annotaterb.yml
 - lib/templates/stateman/migration.rb.erb
 - lib/templates/stateman/state_machine.rb.erb
 - lib/templates/stateman/transition.rb.erb
@@ -288,6 +289,8 @@ files:
 - lib/toolx/core/concerns/custom_identifier.rb
 - lib/toolx/core/concerns/date_time_to_boolean.rb
 - lib/toolx/core/concerns/inquirer.rb
+- lib/toolx/core/concerns/keygen.rb
+- lib/toolx/core/concerns/tokenizer.rb
 - lib/toolx/core/concerns/transformer.rb
 - lib/toolx/core/concerns/with_state_machine.rb
 - lib/toolx/core/env.rb
@@ -330,7 +333,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.3
 specification_version: 4
 summary: Toolx is a set of tools for Ruby on Rails applications that simplifies common
   tasks and enhances development experience.