reportable_rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7e5ec2f4a9c2f8a9cdcbfeb33e8644619d50ea228b41406b6f9722a696139969
+  data.tar.gz: 607c06c8e2f02dcb465bbc3f22da9c0bbdf4516e67aed9191f437dc3eb38d901
+SHA512:
+  metadata.gz: a26f5731f97be20f52a7e887a38dbe80037681e0c759fef6df9a5d79f3bdd31b0de1e7aa7f8b45d70e7039a8ba86b32d3843e7545112d44c8cc6f8a0a5ea3e09
+  data.tar.gz: 951dd89ad30271c6c0a9ebaae267a9dd78017277f858b52d3795cae394cc52f067e2440189482c00e5e6b7dd66fbb8e78362074cc33c6c63f00ce4fb13070319

data/README.md

@@ -0,0 +1,97 @@
+# ReportableRails
+
+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
+  }
+end
+```
+
+## Usage
+
+### Setting Up Models
+
+Include the Report module in your model:
+
+```ruby
+class TimeReport < ApplicationRecord
+  include ReportableRails::Models::Report
+end
+```
+
+This will add the following associations and functionality to your model:
+- `belongs_to :owner` (user who owns the report)
+- `belongs_to :report_category` (optional categorization)
+- `has_many :hours_logs` (time entries for the report)
+
+### 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')
+)
+```
+
+## License
+
+The gem is available as open source under the terms of the MIT License.

data/lib/reportable_rails/models/report.rb

@@ -0,0 +1,53 @@
+module ReportableRails
+  module Models
+    module Report
+      extend ActiveSupport::Concern
+
+      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
+
+        validates :owner, presence: true
+
+        def add_hours_log(hours_log_params)
+          hours_logs.create(hours_log_params)
+        end
+
+        def remove_hours_log(hours_log_id)
+          hours_logs.find_by(id: hours_log_id)&.destroy
+        end
+
+        def current_period_start_date
+          if Date.current.day <= 15
+            Date.current.beginning_of_month
+          else
+            Date.current.beginning_of_month + 15.days
+          end
+        end
+
+        def current_period_end_date
+          if Date.current.day <= 15
+            Date.current.beginning_of_month + 15.days
+          else
+            Date.current.end_of_month
+          end
+        end
+
+        def submit_current_period_report!
+          return false if current_period_hours.empty?
+          
+          ReportableRails.configuration.report_submitted_callback&.call(self)
+          true
+        rescue StandardError => e
+          Rails.logger.error("Failed to submit current period report: #{e.message}")
+          false
+        end
+
+        def current_period_hours
+          hours_logs.select(&:current_period?)
+        end
+      end
+    end
+  end
+end

data/lib/reportable_rails/version.rb

@@ -0,0 +1,3 @@
+module ReportableRails
+  VERSION = "0.1.0"
+end

data/lib/reportable_rails.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'rails/engine'
+require 'active_model_serializers'
+require 'reportable_rails/version'
+
+module ReportableRails
+  class Error < StandardError; end
+  
+  class Engine < ::Rails::Engine
+    isolate_namespace ReportableRails
+    
+    initializer 'reportable_rails.initialize' do |app|
+      # Add any initialization code here
+    end
+    
+    config.generators do |g|
+      g.test_framework :rspec
+      g.fixture_replacement :factory_bot
+      g.factory_bot dir: 'spec/factories'
+    end
+  end
+  
+  # Configuration
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :user_class, :default_category_name
+    
+    def initialize
+      @user_class = 'User'
+      @default_category_name = 'Uncategorized'
+    end
+  end
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: reportable_rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nicu Listana
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ReportableRails provides a complete solution for managing user reports,
+  hours logging, and report categories in Ruby on Rails applications
+email:
+- nicu@adoboenterprisesus.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/reportable_rails.rb
+- lib/reportable_rails/models/report.rb
+- lib/reportable_rails/version.rb
+homepage: https://github.com/adobocorp/reportable_rails
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: A Rails engine for handling user reports and hours logging
+test_files: []