reportable_rails 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0859e1f21d09920db40681907ff7678cffb1b5bda35a0a34e6b1a940de57055c'
-  data.tar.gz: 8bc039930b898a3b5ce8d051ca239f990df3146cdfc9f0c5cec58ba03fd4b174
+  metadata.gz: 2599e880a8d9608af3f17d210f19e6b17ffab9dddad24572c55fdca8187e7a7e
+  data.tar.gz: 3c19a1cfba98ccdfc4279e48b9f9f4c3006b360fbdfc50279c259a3d1d2e7192
 SHA512:
-  metadata.gz: 84f228e677dc9b530cb06c2e5a3e75412d46a6ab787def6bbd88f43655ffae28041686729e686faf453e763ea235792c3c32134006cbb31f0227c1cfa37f5117
-  data.tar.gz: 65832dbf3b45bda9bc8e11999378ad99ce810a5ae05e6398d6c840671fdaa0172895c679c1c15fcfe0c151e4c29708f6e75d941d7afa455d0bc4ca85b2a92ec4
+  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/version.rb

@@ -1,3 +1,3 @@
 module ReportableRails
-  VERSION = "0.1.1"
+  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.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Nicu Listana