reportable_rails 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2599e880a8d9608af3f17d210f19e6b17ffab9dddad24572c55fdca8187e7a7e
-  data.tar.gz: 3c19a1cfba98ccdfc4279e48b9f9f4c3006b360fbdfc50279c259a3d1d2e7192
+  metadata.gz: ef90324ca92f03a4efba50015b5a1b7f39d613d401ba0232b7808567f473c2e7
+  data.tar.gz: ce4f851f7bd2f814d84b0b0bb73a03e9018392e54c38211dfcdda614f46d1dac
 SHA512:
-  metadata.gz: d9cc252b5b6fb17a348cd610944724768c89ed91b3dc0be469b9f8683fdf0e85d1342acda5ee71aca5bfcc2c5fd92bc5bc90b26afe6c2292bfa9f67e24272de5
-  data.tar.gz: 19bb2d807d7c4c968093ebfc4d46098906e0920b87f467bbb01937495f5feb6faf70dfe56eb7b001879f6d06ddf53592ed938977834f2e7e50b5fd336acf305a
+  metadata.gz: 293a7567e11664b79d5eea075a35f64cb112d1bb95de105fb2e7227902b55b97d2fd50886510c6d5d67c8eea1ff4816a6437b55ff72073d8b5978684807dd8b4
+  data.tar.gz: e530c203a222dab06ea1f1f184515a7ce114141b7d5a14e7c6c00e2176c0120b98f9b84e25db7521225df4e96927c991aaf6b93185876b377bcca386f8e0a993

data/README.md

@@ -1,5 +1,12 @@
 # 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
@@ -31,6 +38,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
 ```
 
@@ -121,6 +131,27 @@ 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:

data/Rakefile

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

data/lib/reportable_rails/errors.rb

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

data/lib/reportable_rails/models/hours_log.rb

@@ -4,7 +4,7 @@ module ReportableRails
       extend ActiveSupport::Concern
 
       included do
-        belongs_to :report, class_name: 'ReportableRails::Report'
+        belongs_to :report
 
         validates :hours, presence: true, numericality: { greater_than: 0, less_than_or_equal_to: 24 }
         validates :date, presence: true

data/lib/reportable_rails/models/report.rb

@@ -5,12 +5,13 @@ module ReportableRails
 
       included do
         belongs_to :owner, class_name: ReportableRails.configuration.user_class
-        belongs_to :report_category, class_name: 'ReportableRails::ReportCategory', optional: true
-        has_many :hours_logs, class_name: 'ReportableRails::HoursLog', dependent: :destroy
+        belongs_to :report_category, optional: true
+        has_many :hours_logs, dependent: :destroy
 
         validates :owner, presence: true
 
         def add_hours_log(hours_log_params)
+          validate_period_for_date(hours_log_params[:date])
           hours_logs.create(hours_log_params)
         end
 
@@ -28,7 +29,7 @@ module ReportableRails
 
         def current_period_end_date
           if Date.current.day <= 15
-            Date.current.beginning_of_month + 15.days
+            Date.current.beginning_of_month + 14.days
           else
             Date.current.end_of_month
           end
@@ -47,6 +48,17 @@ module ReportableRails
         def current_period_hours
           hours_logs.select(&:current_period?)
         end
+
+        private
+
+        def validate_period_for_date(date)
+          return if date.nil?
+          
+          unless date >= current_period_start_date && date <= current_period_end_date
+            raise InvalidPeriodError, "Date must be within the current reporting period (#{current_period_start_date} to #{current_period_end_date})"
+          end
+        end
+
       end
     end
   end

data/lib/reportable_rails/models/report_category.rb

@@ -4,23 +4,38 @@ module ReportableRails
       extend ActiveSupport::Concern
 
       included do
-        has_many :reports, class_name: 'ReportableRails::Report', dependent: :nullify
+        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
@@ -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.2"
+  VERSION = "0.1.4"
 end

data/lib/reportable_rails.rb

@@ -3,6 +3,7 @@
 require 'rails/engine'
 require 'active_model_serializers'
 require 'reportable_rails/version'
+require 'reportable_rails/errors'
 require 'reportable_rails/models/report'
 require 'reportable_rails/models/report_category'
 require 'reportable_rails/models/hours_log'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reportable_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Nicu Listana
@@ -37,6 +37,90 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+- !ruby/object:Gem::Dependency
+  name: reportable_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+- !ruby/object:Gem::Dependency
+  name: tzinfo-data
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2023'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2023'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -44,7 +128,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -93,6 +177,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  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'
 description: ReportableRails provides a complete solution for managing user reports,
   hours logging, and report categories in Ruby on Rails applications
 email:
@@ -102,7 +200,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
+- Rakefile
 - lib/reportable_rails.rb
+- lib/reportable_rails/errors.rb
 - lib/reportable_rails/models/hours_log.rb
 - lib/reportable_rails/models/report.rb
 - lib/reportable_rails/models/report_category.rb