reportable_rails 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e5ec2f4a9c2f8a9cdcbfeb33e8644619d50ea228b41406b6f9722a696139969
-  data.tar.gz: 607c06c8e2f02dcb465bbc3f22da9c0bbdf4516e67aed9191f437dc3eb38d901
+  metadata.gz: 2599e880a8d9608af3f17d210f19e6b17ffab9dddad24572c55fdca8187e7a7e
+  data.tar.gz: 3c19a1cfba98ccdfc4279e48b9f9f4c3006b360fbdfc50279c259a3d1d2e7192
 SHA512:
-  metadata.gz: a26f5731f97be20f52a7e887a38dbe80037681e0c759fef6df9a5d79f3bdd31b0de1e7aa7f8b45d70e7039a8ba86b32d3843e7545112d44c8cc6f8a0a5ea3e09
-  data.tar.gz: 951dd89ad30271c6c0a9ebaae267a9dd78017277f858b52d3795cae394cc52f067e2440189482c00e5e6b7dd66fbb8e78362074cc33c6c63f00ce4fb13070319
+  metadata.gz: d9cc252b5b6fb17a348cd610944724768c89ed91b3dc0be469b9f8683fdf0e85d1342acda5ee71aca5bfcc2c5fd92bc5bc90b26afe6c2292bfa9f67e24272de5
+  data.tar.gz: 19bb2d807d7c4c968093ebfc4d46098906e0920b87f467bbb01937495f5feb6faf70dfe56eb7b001879f6d06ddf53592ed938977834f2e7e50b5fd336acf305a

data/README.md

@@ -38,18 +38,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 +121,56 @@ report = TimeReport.create!(
 )
 ```
 
+### 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/hours_log.rb

@@ -0,0 +1,34 @@
+module ReportableRails
+  module Models
+    module HoursLog
+      extend ActiveSupport::Concern
+
+      included do
+        belongs_to :report, class_name: 'ReportableRails::Report'
+
+        validates :hours, presence: true, numericality: { greater_than: 0, less_than_or_equal_to: 24 }
+        validates :date, presence: true
+        validates :description, presence: true, length: { maximum: 1000 }
+
+        validate :date_within_period
+
+        # Check if the hours log belongs to the current reporting period
+        def current_period?
+          return false unless report && date
+
+          date >= report.current_period_start_date && date <= report.current_period_end_date
+        end
+
+        private
+
+        def date_within_period
+          return unless date && report
+
+          unless date >= report.current_period_start_date && date <= report.current_period_end_date
+            errors.add(:date, "must be within the current reporting period (#{report.current_period_start_date} to #{report.current_period_end_date})")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/reportable_rails/models/report_category.rb

@@ -0,0 +1,42 @@
+module ReportableRails
+  module Models
+    module ReportCategory
+      extend ActiveSupport::Concern
+
+      included do
+        has_many :reports, class_name: 'ReportableRails::Report', dependent: :nullify
+
+        validates :name, presence: true, uniqueness: { case_sensitive: false }
+        validates :description, length: { maximum: 1000 }
+        validates :active, inclusion: { in: [true, false] }
+
+        # Scopes
+        scope :active, -> { where(active: true) }
+        scope :ordered, -> { order(:name) }
+
+        before_validation :set_default_active
+
+        private
+
+        def set_default_active
+          self.active = true if active.nil?
+        end
+      end
+
+      module ClassMethods
+        # Find or create a category by name
+        def find_or_create_by_name(name, description: nil)
+          find_or_create_by(name: name) do |category|
+            category.description = description if description.present?
+          end
+        end
+
+        # Deactivate a category without deleting it
+        def deactivate(name)
+          category = find_by(name: name)
+          category&.update(active: false)
+        end
+      end
+    end
+  end
+end

data/lib/reportable_rails/version.rb

@@ -1,3 +1,3 @@
 module ReportableRails
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 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.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Nicu Listana
@@ -103,7 +103,9 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/reportable_rails.rb
+- lib/reportable_rails/models/hours_log.rb
 - lib/reportable_rails/models/report.rb
+- lib/reportable_rails/models/report_category.rb
 - lib/reportable_rails/version.rb
 homepage: https://github.com/adobocorp/reportable_rails
 licenses: