reportable_rails 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0859e1f21d09920db40681907ff7678cffb1b5bda35a0a34e6b1a940de57055c'
-  data.tar.gz: 8bc039930b898a3b5ce8d051ca239f990df3146cdfc9f0c5cec58ba03fd4b174
+  metadata.gz: ec42191250593fe984e7f62ffb0dfbb6367aaa63226267d687f285141a76a5bf
+  data.tar.gz: 65d2a6a9a3e1c6c7e57343586018daba7257e97cd565bfee87023d79fe48935c
 SHA512:
-  metadata.gz: 84f228e677dc9b530cb06c2e5a3e75412d46a6ab787def6bbd88f43655ffae28041686729e686faf453e763ea235792c3c32134006cbb31f0227c1cfa37f5117
-  data.tar.gz: 65832dbf3b45bda9bc8e11999378ad99ce810a5ae05e6398d6c840671fdaa0172895c679c1c15fcfe0c151e4c29708f6e75d941d7afa455d0bc4ca85b2a92ec4
+  metadata.gz: b5cdf9b9698e1f620d19cd18680cef743b6fca62b875cf0c55d313ea893e35e0157a6f013e4f789d12010dca93b26676ca7cf270dd07fb09800ed8d52dbe58a5
+  data.tar.gz: ba76a3b406fbe56b6032c4ed6ee313b445ef4bc6c8d4f9d8f26625201df3c61312d5fbe241e223d17d81f67fceb988e900083f1496d0f0ffd6200880ffa7456c

data/README.md

@@ -31,6 +31,9 @@ ReportableRails.configure do |config|
     # Your custom logic here
     # For example: NotificationMailer.report_submitted(report).deliver_later
   }
+
+  # Customize the name of the default category
+  config.default_category_name = 'General' # Defaults to 'Uncategorized'
 end
 ```
 
@@ -38,18 +41,47 @@ end
 
 ### Setting Up Models
 
-Include the Report module in your model:
+ReportableRails provides three main models that can be included in your application:
 
 ```ruby
+# app/models/time_report.rb
 class TimeReport < ApplicationRecord
   include ReportableRails::Models::Report
 end
+
+# app/models/report_category.rb
+class ReportCategory < ApplicationRecord
+  include ReportableRails::Models::ReportCategory
+end
+
+# app/models/hours_log.rb
+class HoursLog < ApplicationRecord
+  include ReportableRails::Models::HoursLog
+end
 ```
 
-This will add the following associations and functionality to your model:
+Each model provides the following functionality:
+
+#### Report Model
 - `belongs_to :owner` (user who owns the report)
 - `belongs_to :report_category` (optional categorization)
 - `has_many :hours_logs` (time entries for the report)
+- Period management methods
+- Report submission handling
+
+#### Report Category Model
+- `has_many :reports`
+- Name and description tracking
+- Active/inactive status management
+- Scopes for filtering active categories
+- Helper methods for finding and managing categories
+
+#### Hours Log Model
+- `belongs_to :report`
+- Hours and date tracking
+- Period validation
+- Description management
+- Methods for checking if hours are in current period
 
 ### Managing Hours Logs
 
@@ -92,6 +124,77 @@ report = TimeReport.create!(
 )
 ```
 
+### Default Category
+
+ReportableRails automatically manages a default "Uncategorized" category that cannot be deactivated or deleted. You can customize the name of this category in your configuration:
+
+```ruby
+ReportableRails.configure do |config|
+  config.default_category_name = 'General' # Defaults to 'Uncategorized'
+end
+```
+
+To access the default category:
+
+```ruby
+default_category = ReportCategory.default_category # Returns or creates the default category
+```
+
+Reports without a specific category will use this default category. The default category:
+- Cannot be deactivated
+- Cannot be deleted
+- Is automatically created when first accessed
+
+### Database Setup
+
+You'll need to create the necessary database tables. Here are the recommended migrations:
+
+```ruby
+# Create Reports Table
+class CreateReports < ActiveRecord::Migration[6.1]
+  def change
+    create_table :reports do |t|
+      t.references :owner, null: false, foreign_key: { to_table: :users }
+      t.references :report_category, foreign_key: true
+      t.timestamps
+    end
+  end
+end
+
+# Create Report Categories Table
+class CreateReportCategories < ActiveRecord::Migration[6.1]
+  def change
+    create_table :report_categories do |t|
+      t.string :name, null: false
+      t.text :description
+      t.boolean :active, default: true
+      t.timestamps
+      t.index :name, unique: true
+    end
+  end
+end
+
+# Create Hours Logs Table
+class CreateHoursLogs < ActiveRecord::Migration[6.1]
+  def change
+    create_table :hours_logs do |t|
+      t.references :report, null: false, foreign_key: true
+      t.decimal :hours, null: false, precision: 4, scale: 2
+      t.date :date, null: false
+      t.text :description, null: false
+      t.timestamps
+      t.index [:report_id, :date]
+    end
+  end
+end
+```
+
+Run the migrations with:
+
+```bash
+$ rails db:migrate
+```
+
 ## License
 
 The gem is available as open source under the terms of the MIT License.

data/lib/reportable_rails/models/report_category.rb

@@ -9,18 +9,33 @@ module ReportableRails
         validates :name, presence: true, uniqueness: { case_sensitive: false }
         validates :description, length: { maximum: 1000 }
         validates :active, inclusion: { in: [true, false] }
+        validate :prevent_deactivating_default_category
 
         # Scopes
         scope :active, -> { where(active: true) }
         scope :ordered, -> { order(:name) }
 
         before_validation :set_default_active
+        before_destroy :prevent_destroying_default_category
 
         private
 
         def set_default_active
           self.active = true if active.nil?
         end
+
+        def prevent_deactivating_default_category
+          if name == ReportableRails.configuration.default_category_name && !active
+            errors.add(:active, "cannot deactivate the default category")
+          end
+        end
+
+        def prevent_destroying_default_category
+          if name == ReportableRails.configuration.default_category_name
+            errors.add(:base, "cannot delete the default category")
+            throw :abort
+          end
+        end
       end
 
       module ClassMethods
@@ -31,8 +46,15 @@ module ReportableRails
           end
         end
 
+        # Get or create the default category
+        def default_category
+          find_or_create_by_name(ReportableRails.configuration.default_category_name,
+                                description: 'Default category for uncategorized reports')
+        end
+
         # Deactivate a category without deleting it
         def deactivate(name)
+          return false if name == ReportableRails.configuration.default_category_name
           category = find_by(name: name)
           category&.update(active: false)
         end

data/lib/reportable_rails/version.rb

@@ -1,3 +1,3 @@
 module ReportableRails
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
 end

data/lib/reportable_rails.rb

@@ -3,6 +3,9 @@
 require 'rails/engine'
 require 'active_model_serializers'
 require 'reportable_rails/version'
+require 'reportable_rails/models/report'
+require 'reportable_rails/models/report_category'
+require 'reportable_rails/models/hours_log'
 
 module ReportableRails
   class Error < StandardError; end
@@ -32,11 +35,12 @@ module ReportableRails
   end
 
   class Configuration
-    attr_accessor :user_class, :default_category_name
+    attr_accessor :user_class, :default_category_name, :report_submitted_callback
     
     def initialize
       @user_class = 'User'
       @default_category_name = 'Uncategorized'
+      @report_submitted_callback = nil
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reportable_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Nicu Listana