reportable_rails 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef90324ca92f03a4efba50015b5a1b7f39d613d401ba0232b7808567f473c2e7
-  data.tar.gz: ce4f851f7bd2f814d84b0b0bb73a03e9018392e54c38211dfcdda614f46d1dac
+  metadata.gz: ab2d362e38286bc6003486aaa9434c353f2b4450ec41764f53304e351d5a1854
+  data.tar.gz: 16269d2baa8ffcbe33b50a495a609a7a4135803777e03874c2d1522a01336488
 SHA512:
-  metadata.gz: 293a7567e11664b79d5eea075a35f64cb112d1bb95de105fb2e7227902b55b97d2fd50886510c6d5d67c8eea1ff4816a6437b55ff72073d8b5978684807dd8b4
-  data.tar.gz: e530c203a222dab06ea1f1f184515a7ce114141b7d5a14e7c6c00e2176c0120b98f9b84e25db7521225df4e96927c991aaf6b93185876b377bcca386f8e0a993
+  metadata.gz: e6f4bdbd08b88c9f4b7cc04837eb1853069adb28d44f74343e61de7dc3b3cf68432bc27b3c9a8c330613dba20526cbc5f262067c99deabcae175cefe58f3fd5a
+  data.tar.gz: 28ef75d7cb12851b639518b8f8bca7885d40147dab423e0027c9c20fc5f7817321e0c34fb257e71f4d0d9dacbb577ae67a7443c749004e3569c72b35eb326178

data/README.md

@@ -1,207 +1,207 @@
-# ReportableRails
-
-[![Gem Version](https://badge.fury.io/rb/reportable_rails.svg)](https://badge.fury.io/rb/reportable_rails)
-[![Build Status](https://github.com/adobocorp/reportable_rails/workflows/RSpec%20Tests/badge.svg)](https://github.com/adobocorp/reportable_rails/actions)
-[![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
-[![Maintainability](https://api.codeclimate.com/v1/badges/YOUR_REPO_ID/maintainability)](https://codeclimate.com/github/adobocorp/reportable_rails)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/YOUR_REPO_ID/test_coverage)](https://codeclimate.com/github/adobocorp/reportable_rails)
-[![Ruby](https://img.shields.io/badge/ruby-2.7%2B-blue)](https://www.ruby-lang.org/en/)
-
-ReportableRails is a Ruby on Rails gem that provides a flexible reporting system for tracking and managing time-based reports with period management.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'reportable_rails'
-```
-
-And then execute:
-
-```bash
-$ bundle install
-```
-
-## Configuration
-
-ReportableRails can be configured in an initializer:
-
-```ruby
-# config/initializers/reportable_rails.rb
-ReportableRails.configure do |config|
-  # Set the user class for report ownership (default: 'User')
-  config.user_class = 'User'
-
-  # Configure a callback for when reports are submitted
-  config.report_submitted_callback = ->(report) {
-    # 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
-```
-
-## Usage
-
-### Setting Up Models
-
-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
-```
-
-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
-
-```ruby
-# Add hours to a report
-report.add_hours_log({
-  hours: 8,
-  date: Date.current,
-  description: 'Project work'
-})
-
-# Remove hours from a report
-report.remove_hours_log(hours_log_id)
-```
-
-### Period Management
-
-The gem includes built-in period management with bi-monthly periods (1st-15th and 16th-end of month):
-
-```ruby
-# Get current period dates
-start_date = report.current_period_start_date
-end_date = report.current_period_end_date
-
-# Get hours for current period
-current_hours = report.current_period_hours
-
-# Submit current period report
-report.submit_current_period_report!
-```
-
-### Report Categories
-
-Reports can be optionally categorized:
-
-```ruby
-report = TimeReport.create!(
-  owner: current_user,
-  report_category: ReportableRails::ReportCategory.find_by(name: 'Project Work')
-)
-```
-
-### 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.
+# ReportableRails
+
+[![Gem Version](https://badge.fury.io/rb/reportable_rails.svg)](https://badge.fury.io/rb/reportable_rails)
+[![Build Status](https://github.com/adobocorp/reportable_rails/workflows/RSpec%20Tests/badge.svg)](https://github.com/adobocorp/reportable_rails/actions)
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
+[![Maintainability](https://api.codeclimate.com/v1/badges/YOUR_REPO_ID/maintainability)](https://codeclimate.com/github/adobocorp/reportable_rails)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/YOUR_REPO_ID/test_coverage)](https://codeclimate.com/github/adobocorp/reportable_rails)
+[![Ruby](https://img.shields.io/badge/ruby-2.7%2B-blue)](https://www.ruby-lang.org/en/)
+
+ReportableRails is a Ruby on Rails gem that provides a flexible reporting system for tracking and managing time-based reports with period management.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'reportable_rails'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+## Configuration
+
+ReportableRails can be configured in an initializer:
+
+```ruby
+# config/initializers/reportable_rails.rb
+ReportableRails.configure do |config|
+  # Set the user class for report ownership (default: 'User')
+  config.user_class = 'User'
+
+  # Configure a callback for when reports are submitted
+  config.report_submitted_callback = ->(report) {
+    # 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
+```
+
+## Usage
+
+### Setting Up Models
+
+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
+```
+
+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
+
+```ruby
+# Add hours to a report
+report.add_hours_log({
+  hours: 8,
+  date: Date.current,
+  description: 'Project work'
+})
+
+# Remove hours from a report
+report.remove_hours_log(hours_log_id)
+```
+
+### Period Management
+
+The gem includes built-in period management with bi-monthly periods (1st-15th and 16th-end of month):
+
+```ruby
+# Get current period dates
+start_date = report.current_period_start_date
+end_date = report.current_period_end_date
+
+# Get hours for current period
+current_hours = report.current_period_hours
+
+# Submit current period report
+report.submit_current_period_report!
+```
+
+### Report Categories
+
+Reports can be optionally categorized:
+
+```ruby
+report = TimeReport.create!(
+  owner: current_user,
+  report_category: ReportableRails::ReportCategory.find_by(name: 'Project Work')
+)
+```
+
+### 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/Rakefile

@@ -1,6 +1,6 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task default: :spec
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/reportable_rails/errors.rb

@@ -1,3 +1,3 @@
-module ReportableRails
-  class InvalidPeriodError < StandardError; end
-end
+module ReportableRails
+  class InvalidPeriodError < StandardError; end
+end

data/lib/reportable_rails/models/hours_log.rb

@@ -1,34 +1,34 @@
-module ReportableRails
-  module Models
-    module HoursLog
-      extend ActiveSupport::Concern
-
-      included do
-        belongs_to :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
+module ReportableRails
+  module Models
+    module HoursLog
+      extend ActiveSupport::Concern
+
+      included do
+        belongs_to :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

@@ -1,64 +1,64 @@
-module ReportableRails
-  module Models
-    module ReportCategory
-      extend ActiveSupport::Concern
-
-      included do
-        has_many :reports, dependent: :nullify
-
-        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
-        # 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
-
-        # 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
-      end
-    end
-  end
-end
+module ReportableRails
+  module Models
+    module ReportCategory
+      extend ActiveSupport::Concern
+
+      included do
+        has_many :reports, dependent: :nullify
+
+        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
+        # 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
+
+        # 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
+      end
+    end
+  end
+end

data/lib/reportable_rails/version.rb

@@ -1,3 +1,3 @@
 module ReportableRails
-  VERSION = "0.1.4"
+  VERSION = "0.1.6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reportable_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - Nicu Listana
@@ -13,128 +13,144 @@ dependencies:
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '6.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '6.1'
-- !ruby/object:Gem::Dependency
-  name: active_model_serializers
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 6.1.7.10
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 6.1.7.10
 - !ruby/object:Gem::Dependency
   name: actionview
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 6.1.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.7.10
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 6.1.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.7.10
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 6.1.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.7.10
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 6.1.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.7.10
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 6.1.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.7.10
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 6.1.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.7.10
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 6.1.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.7.10
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 6.1.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.7.10
 - !ruby/object:Gem::Dependency
-  name: reportable_rails
+  name: tzinfo-data
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.3
+        version: '1.2023'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.3
+        version: '1.2023'
 - !ruby/object:Gem::Dependency
-  name: tzinfo-data
+  name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.2023'
+        version: 1.3.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.2023'
+        version: 1.3.4
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement