recurrence_ui 0.1.0

data/lib/generators/recurrence_ui/views_generator.rb

@@ -0,0 +1,26 @@
+# lib/generators/recurrence_ui/views_generator.rb
+require "rails/generators/base"
+
+module RecurrenceUi
+  module Generators
+    class ViewsGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../../..", __FILE__)
+
+      desc "Copies recurrence_ui views to your application for customization"
+
+      def copy_views
+        # 1. Copy main component template to app/components/recurrence_ui/
+        copy_file(
+          "app/components/recurrence_ui/picker_component.html.erb",
+          "app/components/recurrence_ui/picker_component.html.erb"
+        )
+
+        # 2. Copy all partials from app/views/recurrence_ui/ to app/views/recurrence_ui/
+        directory(
+          "app/views/recurrence_ui",
+          "app/views/recurrence_ui"
+        )
+      end
+    end
+  end
+end

data/lib/recurrence_ui/configuration.rb

@@ -0,0 +1,116 @@
+# lib/recurrence_ui/configuration.rb
+module RecurrenceUi
+  class Configuration
+    
+    SUPPORTED_LOCALES = %w[en ru ja uk be].freeze # Locales for which yml files are available in the gem
+    DEFAULT_LOCALE = 'en'.freeze
+    DEFAULT_TIME_ZONE = 'UTC'.freeze
+    DEFAULT_WEEK_START = 0
+    DEFAULT_DURATION = 0 # Default duration in seconds if not specified
+    ALL_RULE_TYPES = %w[
+          never
+          daily
+          weekly
+          monthly_by_day_of_month
+          monthly_by_weekday
+          yearly_by_day_of_month
+          yearly_by_weekday
+        ].freeze
+
+    attr_accessor :enabled_rule_types, 
+                  :locale, 
+                  :time_zone, 
+                  :week_start, 
+                  :supported_locales, 
+                  :theme_mode,
+                  :default_recurring_rules_field,
+                  :default_start_time_field,
+                  :default_end_time_field,
+                  :default_time_zone_field,
+                  :default_duration_field
+    
+    def initialize
+      @locale = nil
+      @time_zone = nil
+      @week_start = nil
+      @duration = nil
+      @theme_mode = :auto     # Example: :auto (default), :light (light only), :dark (dark only)
+      @supported_locales = SUPPORTED_LOCALES
+      @enabled_rule_types = ALL_RULE_TYPES.dup
+      @default_recurring_rules_field = :recurring_rules
+      @default_start_time_field      = :start_at
+      @default_end_time_field        = :end_at
+      @default_time_zone_field       = :time_zone
+      @default_duration_field        = :duration
+    end
+
+    def resolved_locale(requested = nil)
+      # 1. Get the candidate locale
+      # Priority: requested -> I18n.locale -> @locale
+      candidate = requested&.to_s.presence ||
+                  (defined?(I18n) && I18n.locale&.to_s.presence) ||
+                  @locale&.to_s.presence
+
+      # 2. Validate against supported locales
+      if SUPPORTED_LOCALES.include?(candidate)
+        candidate
+      else
+        # Log Unsupported Locale Warning: Log a warning in dev mode if an unsupported locale is received
+        log_unsupported_locale_warning(candidate) if candidate.present?
+        
+        DEFAULT_LOCALE
+      end
+    end
+
+    def resolved_time_zone(requested = nil)
+      # Priority: requested -> Time.zone -> @time_zone
+      candidate = requested.presence ||
+                  (defined?(Time) && Time.respond_to?(:zone) && Time.zone&.name.presence) ||
+                  @time_zone.presence
+        # Check if the time zone exists in Rails
+        if candidate.present? && defined?(ActiveSupport::TimeZone) && ActiveSupport::TimeZone[candidate].present?
+            candidate
+        else
+            DEFAULT_TIME_ZONE
+        end
+    end
+
+    def resolved_week_start(requested = nil)
+      # Priority: requested -> Date.beginning_of_week -> @week_start
+      rails_week_start = defined?(Date) && Date.respond_to?(:beginning_of_week) ? (Date.beginning_of_week == :monday ? 1 : 0) : nil
+
+      raw = requested.presence ||
+            rails_week_start ||
+            @week_start.presence
+  
+      normalized = normalize_week_start(raw)
+      [0, 1].include?(normalized) ? normalized : DEFAULT_WEEK_START
+    end
+    
+    # Method for resolving enabled rule types with filtering and user-defined order preservation
+    def resolved_enabled_rule_types(passed_types = nil)
+      candidate = passed_types.presence || @enabled_rule_types.presence || ALL_RULE_TYPES
+      candidate = Array(candidate).map(&:to_s)
+
+      #Use only valid types, preserving the user-defined order
+      valid_types = candidate.select { |t| ALL_RULE_TYPES.include?(t) }
+      valid_types.presence || ALL_RULE_TYPES
+    end
+
+    private
+    # Logs a warning in development mode if an unsupported locale is received
+    def log_unsupported_locale_warning(locale)
+      if defined?(Rails) && Rails.respond_to?(:logger) && Rails.logger && Rails.env.development?
+        Rails.logger.warn("[RecurrenceUi] Locale '#{locale}' is not supported by the gem. Falling back to '#{DEFAULT_LOCALE}'. Supported locales: #{SUPPORTED_LOCALES.join(', ')}")
+      end
+    end
+    # Normalizes the week_start value to either 0 (Sunday) or 1 (Monday)
+    def normalize_week_start(val)
+      case val&.to_s&.downcase
+      when '1', 'monday', 'mon' then 1
+      when '0', 'sunday', 'sun' then 0
+      else val.to_i
+      end
+    end
+  end
+end

data/lib/recurrence_ui/engine.rb

@@ -0,0 +1,57 @@
+# recurrence_ui/lib/recurrence_ui/engine.rb
+require "recurrence_ui"
+
+module RecurrenceUi
+  class Engine < ::Rails::Engine
+    isolate_namespace RecurrenceUi
+
+    # 1. Tailwind CSS v3 paths
+    initializer "recurrence_ui.tailwindcss" do |app|
+      if app.config.respond_to?(:tailwindcss)
+        app.config.tailwindcss.content_paths << Engine.root.join("app/components/**/*.{erb,haml,html,slim,rb}").to_s
+        app.config.tailwindcss.content_paths << Engine.root.join("app/views/**/*.{erb,haml,html,slim,rb}").to_s
+      end
+    end
+
+    # 2. Add importmap support for the gem
+    initializer "recurrence_ui.importmap", before: "importmap" do |app|
+      if app.config.respond_to?(:importmap)
+        app.config.importmap.paths << Engine.root.join("config/importmap.rb")
+      end
+    end
+
+    # 3. Assets and precompilation of ONLY the necessary files
+    initializer "recurrence_ui.assets" do |app|
+      if app.config.respond_to?(:assets)
+        app.config.assets.paths << Engine.root.join("app/javascript")
+        app.config.assets.paths << Engine.root.join("app/assets/stylesheets")
+        app.config.assets.precompile += %w( recurrence_ui/application.css )
+
+        # Add files for precompilation
+        app.config.assets.precompile += %w(
+          recurrence_ui/index.js
+          recurrence_ui/recurrence_ui_controller.js
+          recurrence_ui.css
+        )
+      end
+    end
+
+    # 4. i18n locales
+    initializer "recurrence_ui.locales" do |app|
+      config.i18n.load_path += Dir[Engine.root.join("config", "locales", "*.{rb,yml}")]
+    end
+
+    # 5. Routes for debugging in development
+    initializer "recurrence_ui.append_routes" do |app|
+      app.routes.append do
+        if Rails.env.development?
+          get '/dev/recurrence_previews', to: 'recurrence_ui/dev/recurrence_previews#index'
+        end
+      end
+    end
+    # Add components to the global ViewComponent / ActionView search
+    config.to_prepare do
+      ApplicationController.helper(RecurrenceUi::Engine.helpers)
+    end
+  end
+end

data/lib/recurrence_ui/version.rb

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

data/lib/recurrence_ui.rb

@@ -0,0 +1,25 @@
+require "rails"
+require "view_component" 
+require "ice_cube" # This gem is used to generate recurrence rules and calculate occurrences of events based on those rules.
+require "rails-i18n" # This gem is used for internationalization and localization of the application.
+
+require "recurrence_ui/version"
+require "recurrence_ui/configuration"
+require "recurrence_ui/engine"
+
+module RecurrenceUi
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration) if block_given?
+    end
+
+    def config
+      configuration
+    end
+  end
+end
+

data/lib/tasks/recurrence_ui_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :recurrence_ui do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,195 @@
+--- !ruby/object:Gem::Specification
+name: recurrence_ui
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Katerina German
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2026-10-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.0
+- !ruby/object:Gem::Dependency
+  name: view_component
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: ice_cube
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rails-i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+description: Provides ViewComponents and Stimulus controllers to build flexible event
+  recurrence schedules using IceCube.
+email:
+- assoly@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/recurrence_ui_manifest.js
+- app/assets/stylesheets/recurrence_ui/application.css
+- app/assets/stylesheets/recurrence_ui/components.css
+- app/assets/stylesheets/recurrence_ui/tokens.css
+- app/components/recurrence_ui/recurrence_picker_component.html.erb
+- app/components/recurrence_ui/recurrence_picker_component.rb
+- app/controllers/recurrence_ui/application_controller.rb
+- app/helpers/recurrence_ui/application_helper.rb
+- app/javascript/recurrence_ui/index.js
+- app/javascript/recurrence_ui/recurrence_ui_controller.js
+- app/jobs/recurrence_ui/application_job.rb
+- app/mailers/recurrence_ui/application_mailer.rb
+- app/models/concerns/recurrence_ui/has_recurrence.rb
+- app/models/recurrence_ui/application_record.rb
+- app/services/recurrence_ui/recurrence_formatter_service.rb
+- app/views/layouts/recurrence_ui/application.html.erb
+- app/views/recurrence_ui/_daily.html.erb
+- app/views/recurrence_ui/_exceptions.html.erb
+- app/views/recurrence_ui/_footer_actions.html.erb
+- app/views/recurrence_ui/_monthly_by_day_of_month.html.erb
+- app/views/recurrence_ui/_monthly_by_weekday.html.erb
+- app/views/recurrence_ui/_rdates.html.erb
+- app/views/recurrence_ui/_rule_card.html.erb
+- app/views/recurrence_ui/_summary_link.html.erb
+- app/views/recurrence_ui/_termination.html.erb
+- app/views/recurrence_ui/_weekly.html.erb
+- app/views/recurrence_ui/_yearly_by_day_of_month.html.erb
+- app/views/recurrence_ui/_yearly_by_weekday.html.erb
+- config/i18n-tasks.yml
+- config/importmap.rb
+- config/locales/recurrence_ui.be.yml
+- config/locales/recurrence_ui.en.yml
+- config/locales/recurrence_ui.ja.yml
+- config/locales/recurrence_ui.ru.yml
+- config/locales/recurrence_ui.uk.yml
+- config/routes.rb
+- lib/generators/recurrence_ui/views_generator.rb
+- lib/recurrence_ui.rb
+- lib/recurrence_ui/configuration.rb
+- lib/recurrence_ui/engine.rb
+- lib/recurrence_ui/version.rb
+- lib/tasks/recurrence_ui_tasks.rake
+homepage: https://github.com/assoly/recurrence_ui
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/assoly/recurrence_ui
+  changelog_uri: https://github.com/assoly/recurrence_ui/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key: 
+specification_version: 4
+summary: UI component for IceCube schedule generation in Rails.
+test_files: []