referral_box 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 867473469f84b50eb1d91c236e8b8dea1d704fe4e500988220bebe540ac1d7e2
-  data.tar.gz: 0bc7e4a1e9ebfc8eeccd44852e935565f2b7d18a6e392d9ddff4212a2f66bf49
+  metadata.gz: cf16b9679f6e24b2be6b829656425f355ffd2e66bbbdf7fbc2ccc6054848d4c3
+  data.tar.gz: c3ef398f59824859c6397c25fa5a6e19f67331e100b746cb22b766d7ce9c4656
 SHA512:
-  metadata.gz: 94996431776ddc4285e95d4d985b9a1db86a9f42a2516b483d93b319bbd72eb1aae6d7705f341969934f30f8c4e763c02b22f228737a285f695e7c2ffcb7c8f6
-  data.tar.gz: 6d7f771dfdfd942c6503281b34783ee907474ebfa023866fa84d5890a87746148507113a4a375eaade80b151ac0480dcb615038a6b8e8ccbf15f370c1a33a8cf
+  metadata.gz: a3eb0fcfad35a71dd6306a58ee64377a96a37bc225e5e8ce2e406c7c368e5e2be85a0f62cec1253d657a3c2a2906580cfff489ef6baa4e842e1ca2ac62655dbc
+  data.tar.gz: b348dc01aec33cf0fb870c182a6d8d0b72a286abd95bbc332a14f44dcf0a8f98bcf8158337651fb7f1a196fe4784358ae53a85302e3e941997fffb39e0826074

data/CHANGELOG.md

@@ -7,6 +7,25 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.1.3] - 2025-01-XX
+
+### Fixed
+- **Migration Version Issue**: Fixed Rails migration version format to use "8.0" instead of "8"
+- **Generator Compatibility**: Migration generator now works correctly with Rails 8.x applications
+
+## [0.1.2] - 2025-01-XX
+
+### Fixed
+- **Migration Issue**: Fixed NOT NULL constraint error by making referrer_id nullable
+- **Generator Improvements**: Removed interactive prompts, now reads configuration from initializer
+- **Model Flexibility**: Generator automatically detects and uses the configured model class name
+- **Migration Generation**: Creates proper migrations with correct table names and constraints
+
+### Changed
+- Generator no longer asks questions - uses `reference_class_name` from initializer
+- Migration adds `null: true` to referrer_id to prevent constraint violations
+- Added unique index on referral_code column
+
 ## [0.1.1] - 2025-01-XX
 
 ### Fixed

data/lib/generators/referral_box/install/install_generator.rb

@@ -11,21 +11,39 @@ module ReferralBox
         template "initializer.rb", "config/initializers/referral_box.rb"
       end
 
-      def add_user_model_migration
-        generate_migration = ask("Would you like to add referral_code and tier columns to your User model? (y/n)")
+      def add_model_migration
+        # Read the configuration to determine the model class name
+        model_class = get_model_class_name
         
-        if generate_migration.downcase == 'y'
-          generate "migration", "AddReferralBoxToUsers referral_code:string tier:string referrer:references"
-          puts "Migration generated! Run 'rails db:migrate' to apply it."
+        if model_class.present?
+          generate_migration = "AddReferralBoxTo#{model_class.pluralize}"
+          migration_content = generate_migration_content(model_class)
+          
+          create_file "db/migrate/#{Time.current.strftime('%Y%m%d%H%M%S')}_#{generate_migration.underscore}.rb", migration_content
+          
+          puts "Migration generated for #{model_class} model!"
+          puts "Run 'rails db:migrate' to apply it."
+        else
+          puts "Warning: Could not determine model class name from configuration."
+          puts "Please manually create migration for your model."
         end
       end
 
-      def add_user_model_methods
-        user_class = ask("What is your user model class name? (default: User)")
-        user_class = "User" if user_class.blank?
+      def add_model_methods
+        model_class = get_model_class_name
         
-        template "user_model.rb", "app/models/#{user_class.downcase}.rb", skip: true
-        puts "Please add the ReferralBox methods to your #{user_class} model manually."
+        if model_class.present?
+          model_file = "app/models/#{model_class.underscore}.rb"
+          
+          if File.exist?(model_file)
+            inject_into_file model_file, after: "class #{model_class} < ApplicationRecord" do
+              "\n  " + generate_model_methods(model_class)
+            end
+            puts "Added ReferralBox methods to #{model_class} model."
+          else
+            puts "Warning: #{model_file} not found. Please manually add ReferralBox methods to your #{model_class} model."
+          end
+        end
       end
 
       def show_instructions
@@ -34,12 +52,83 @@ module ReferralBox
         puts "="*60
         puts "\nNext steps:"
         puts "1. Run 'rails db:migrate' to create the database tables"
-        puts "2. Add ReferralBox methods to your User model (see template)"
-        puts "3. Configure ReferralBox in config/initializers/referral_box.rb"
-        puts "4. Visit /referral_box to access the admin dashboard"
+        puts "2. Configure ReferralBox in config/initializers/referral_box.rb"
+        puts "3. Visit /referral_box to access the admin dashboard"
         puts "\nFor more information, see the documentation!"
         puts "="*60
       end
+
+      private
+
+      def get_model_class_name
+        # Try to read from existing initializer first
+        initializer_path = "config/initializers/referral_box.rb"
+        
+        if File.exist?(initializer_path)
+          content = File.read(initializer_path)
+          if match = content.match(/config\.reference_class_name\s*=\s*['"]([^'"]+)['"]/)
+            return match[1]
+          end
+        end
+        
+        # Default to 'User' if not found
+        'User'
+      end
+
+      def generate_migration_content(model_class)
+        <<~MIGRATION
+          # frozen_string_literal: true
+
+          class AddReferralBoxTo#{model_class.pluralize} < ActiveRecord::Migration[#{get_rails_version}]
+            def change
+              add_column :#{model_class.underscore.pluralize}, :referral_code, :string
+              add_column :#{model_class.underscore.pluralize}, :tier, :string
+              add_reference :#{model_class.underscore.pluralize}, :referrer, null: true, foreign_key: { to_table: :#{model_class.underscore.pluralize} }
+              
+              add_index :#{model_class.underscore.pluralize}, :referral_code, unique: true
+            end
+          end
+        MIGRATION
+      end
+
+      def get_rails_version
+        # Get the major and minor version (e.g., "8.0" instead of just "8")
+        major, minor = Rails.version.split('.')[0..1]
+        "#{major}.#{minor}"
+      end
+
+      def generate_model_methods(model_class)
+        <<~METHODS
+          has_many :referral_box_transactions, class_name: 'ReferralBox::Transaction', as: :user
+          has_many :referrals, class_name: '#{model_class}', foreign_key: 'referrer_id'
+          belongs_to :referrer, class_name: '#{model_class}', optional: true
+
+          before_create :generate_referral_code
+
+          def points_balance
+            ReferralBox.balance(self)
+          end
+
+          def current_tier
+            ReferralBox.tier(self)
+          end
+
+          def referral_link
+            "\#{Rails.application.routes.url_helpers.root_url}?ref=\#{referral_code}"
+          end
+
+          private
+
+          def generate_referral_code
+            return if referral_code.present?
+
+            loop do
+              self.referral_code = SecureRandom.alphanumeric(ReferralBox.configuration.referral_code_length).upcase
+              break unless #{model_class}.exists?(referral_code: referral_code)
+            end
+          end
+        METHODS
+      end
     end
   end
 end 

data/lib/generators/referral_box/install/templates/initializer.rb

@@ -2,7 +2,8 @@
 
 ReferralBox.configure do |config|
   # Define which model represents your app's user/customer
-  config.reference_class_name = 'User' # or 'Customer', 'Account', etc.
+  # Change this to match your model: 'User', 'Customer', 'Account', 'Member', etc.
+  config.reference_class_name = 'User'
 
   # Custom earning rule - earn points based on events
   config.earning_rule = ->(user, event) do

data/lib/referral_box/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: referral_box
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Kapil Dev Pal
@@ -16,56 +16,80 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
 - !ruby/object:Gem::Dependency
   name: actionview
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
 - !ruby/object:Gem::Dependency
   name: kaminari
   requirement: !ruby/object:Gem::Requirement
@@ -84,28 +108,28 @@ dependencies:
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
   name: factory_bot_rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '6.0'
 - !ruby/object:Gem::Dependency
@@ -173,7 +197,6 @@ files:
 - db/migrate/002_create_referral_box_referral_logs.rb
 - lib/generators/referral_box/install/install_generator.rb
 - lib/generators/referral_box/install/templates/initializer.rb
-- lib/generators/referral_box/install/templates/user_model.rb
 - lib/referral_box.rb
 - lib/referral_box/configuration.rb
 - lib/referral_box/engine.rb

data/lib/generators/referral_box/install/templates/user_model.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-class User < ApplicationRecord
-  # Add these columns to your users table:
-  # add_column :users, :referral_code, :string
-  # add_column :users, :tier, :string
-  # add_index :users, :referral_code, unique: true
-
-  has_many :referral_box_transactions, class_name: 'ReferralBox::Transaction', as: :user
-  has_many :referrals, class_name: 'User', foreign_key: 'referrer_id'
-  belongs_to :referrer, class_name: 'User', optional: true
-
-  before_create :generate_referral_code
-
-  def points_balance
-    ReferralBox.balance(self)
-  end
-
-  def current_tier
-    ReferralBox.tier(self)
-  end
-
-  def referral_link
-    "#{Rails.application.routes.url_helpers.root_url}?ref=#{referral_code}"
-  end
-
-  def total_referrals
-    referrals.count
-  end
-
-  def successful_referrals
-    referrals.joins(:referral_box_transactions).distinct.count
-  end
-
-  private
-
-  def generate_referral_code
-    return if referral_code.present?
-
-    loop do
-      self.referral_code = SecureRandom.alphanumeric(ReferralBox.configuration.referral_code_length).upcase
-      break unless User.exists?(referral_code: referral_code)
-    end
-  end
-end