elaine_crud 0.1.0

data/lib/elaine_crud/sorting_concern.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module ElaineCrud
+  # Concern for sorting functionality in ElaineCrud controllers
+  # Provides methods for URL parameter-based sorting with validation
+  module SortingConcern
+    extend ActiveSupport::Concern
+
+    # Get current sort column from params or default
+    # @return [Symbol] The sort column
+    def current_sort_column
+      if params[:sort].present? && valid_sort_column?(params[:sort])
+        params[:sort].to_sym
+      else
+        self.class.default_sort_column || :id
+      end
+    end
+
+    # Get current sort direction from params or default
+    # @return [Symbol] The sort direction (:asc or :desc)
+    def current_sort_direction
+      if params[:direction].present? && %w[asc desc].include?(params[:direction])
+        params[:direction].to_sym
+      else
+        self.class.default_sort_direction || :asc
+      end
+    end
+
+    # Get the opposite direction for toggling sort
+    # @param current_direction [Symbol] Current sort direction
+    # @return [Symbol] Opposite direction
+    def toggle_sort_direction(current_direction)
+      current_direction.to_sym == :asc ? :desc : :asc
+    end
+
+    private
+
+    # Apply sorting to the records based on URL parameters
+    # @param records [ActiveRecord::Relation] The base query
+    # @return [ActiveRecord::Relation] The sorted query
+    def apply_sorting(records)
+      sort_column = current_sort_column
+      sort_direction = current_sort_direction
+
+      # Validate sort column exists
+      return records unless valid_sort_column?(sort_column)
+
+      # Use Arel to safely construct ORDER BY clause
+      # This prevents SQL injection in column names
+      table = crud_model.arel_table
+      records.order(table[sort_column].send(sort_direction))
+    end
+
+    # Check if a column is valid for sorting
+    # @param column [String, Symbol] The column name
+    # @return [Boolean] True if valid for sorting
+    def valid_sort_column?(column)
+      return false if column.blank?
+
+      column_str = column.to_s
+      crud_model.column_names.include?(column_str) || 
+      crud_model.attribute_names.include?(column_str)
+    end
+  end
+end

data/lib/elaine_crud/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ElaineCrud
+  VERSION = '0.1.0'
+end

data/lib/elaine_crud.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'kaminari'
+
+require_relative 'elaine_crud/version'
+require_relative 'elaine_crud/engine'
+require_relative 'elaine_crud/field_configuration'
+require_relative 'elaine_crud/sorting_concern'
+require_relative 'elaine_crud/search_and_filtering'
+
+# Controller concerns
+require_relative 'elaine_crud/dsl_methods'
+require_relative 'elaine_crud/field_configuration_methods'
+require_relative 'elaine_crud/layout_calculation'
+require_relative 'elaine_crud/relationship_handling'
+require_relative 'elaine_crud/record_fetching'
+require_relative 'elaine_crud/parameter_handling'
+require_relative 'elaine_crud/export_handling'
+
+# Routing helper
+require_relative 'elaine_crud/routing'
+
+module ElaineCrud
+  class Error < StandardError; end
+end

data/lib/tasks/demo.rake

@@ -0,0 +1,111 @@
+namespace :demo do
+  desc "Run the demo application server"
+  task :server do
+    puts "Starting ElaineCrud Demo Application..."
+    puts "=" * 60
+    puts "Navigate to: http://localhost:3000"
+    puts "=" * 60
+
+    Dir.chdir(File.expand_path('../../test/dummy_app', __dir__)) do
+      exec "bin/rails server"
+    end
+  end
+
+  desc "Setup demo database (migrate and seed)"
+  task :setup do
+    puts "Setting up demo database..."
+    Dir.chdir(File.expand_path('../../test/dummy_app', __dir__)) do
+      puts "\n1. Creating database..."
+      system("bin/rails db:create") || abort("Database creation failed")
+
+      puts "\n2. Running migrations..."
+      system("bin/rails db:migrate") || abort("Migration failed")
+
+      puts "\n3. Seeding database with sample data..."
+      system("bin/rails db:seed") || abort("Seeding failed")
+
+      puts "\n" + "=" * 60
+      puts "Demo setup complete!"
+      puts "Run: rake demo:server"
+      puts "=" * 60
+    end
+  end
+
+  desc "Reset demo database (drop, create, migrate, seed)"
+  task :reset do
+    puts "Resetting demo database..."
+    Dir.chdir(File.expand_path('../../test/dummy_app', __dir__)) do
+      puts "\n1. Dropping database..."
+      system("bin/rails db:drop")
+
+      puts "\n2. Creating database..."
+      system("bin/rails db:create") || abort("Database creation failed")
+
+      puts "\n3. Running migrations..."
+      system("bin/rails db:migrate") || abort("Migration failed")
+
+      puts "\n4. Seeding database with sample data..."
+      system("bin/rails db:seed") || abort("Seeding failed")
+
+      puts "\n" + "=" * 60
+      puts "Demo database reset complete!"
+      puts "Run: rake demo:server"
+      puts "=" * 60
+    end
+  end
+
+  desc "Run Rails console in demo app context"
+  task :console do
+    puts "Starting Rails console for demo app..."
+    Dir.chdir(File.expand_path('../../test/dummy_app', __dir__)) do
+      exec "bin/rails console"
+    end
+  end
+
+  desc "Open Rails database console for demo app"
+  task :dbconsole do
+    puts "Starting database console for demo app..."
+    Dir.chdir(File.expand_path('../../test/dummy_app', __dir__)) do
+      exec "bin/rails dbconsole"
+    end
+  end
+
+  desc "Display demo app information and available routes"
+  task :info do
+    puts "\n" + "=" * 60
+    puts "ElaineCrud Demo Application Information"
+    puts "=" * 60
+
+    puts "\nAvailable Resources:"
+    puts "  - Libraries (has_many books, members, librarians)"
+    puts "  - Authors (has_many books)"
+    puts "  - Books (belongs_to author, library | has_many loans)"
+    puts "  - Members (belongs_to library | has_many loans)"
+    puts "  - Loans (belongs_to book, member)"
+    puts "  - Librarians (belongs_to library)"
+
+    puts "\nFeatures Demonstrated:"
+    puts "  ✓ Automatic foreign key detection and dropdowns"
+    puts "  ✓ Has-many relationships with counts"
+    puts "  ✓ Custom field display (currency, dates, booleans)"
+    puts "  ✓ Dropdown options for enums"
+    puts "  ✓ Status badges with colors"
+    puts "  ✓ Parent-child filtering"
+    puts "  ✓ Sorting by columns"
+    puts "  ✓ Inline editing with Turbo"
+
+    puts "\nRake Tasks:"
+    puts "  rake demo:setup     - Initial database setup"
+    puts "  rake demo:reset     - Reset database with fresh data"
+    puts "  rake demo:server    - Start the demo server"
+    puts "  rake demo:console   - Open Rails console"
+    puts "  rake demo:dbconsole - Open database console"
+    puts "  rake demo:info      - Show this information"
+
+    puts "\n" + "=" * 60
+  end
+end
+
+# Set demo:info as the default demo task
+desc "Show ElaineCrud demo information"
+task :demo => 'demo:info'

data/lib/tasks/spec.rake

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+begin
+  require 'rspec/core/rake_task'
+
+  # Note: Main :spec task is defined in Rakefile to avoid duplication
+  # This file only defines namespaced spec tasks for more granular test running
+
+  namespace :spec do
+    desc 'Run integration tests'
+    RSpec::Core::RakeTask.new(:integration) do |t|
+      t.pattern = 'spec/integration/**/*_spec.rb'
+      t.rspec_opts = '--format documentation'
+    end
+
+    desc 'Run integration tests for a specific controller (e.g., rake spec:controller[libraries])'
+    task :controller, [:name] do |t, args|
+      controller_name = args[:name]
+      sh "bundle exec rspec spec/integration/#{controller_name}_crud_spec.rb --format documentation"
+    end
+  end
+
+  task default: :spec
+rescue LoadError
+  # RSpec not available
+end

metadata

@@ -0,0 +1,264 @@
+--- !ruby/object:Gem::Specification
+name: elaine_crud
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Garo
+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.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: kaminari
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: caxlsx
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: csv
+  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: turbo-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: puma
+  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'
+- !ruby/object:Gem::Dependency
+  name: roo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+description: ElaineCrud provides a reusable BaseController and views to quickly generate
+  CRUD interfaces for any ActiveRecord model with minimal configuration.
+email:
+- juho.makinen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- LICENSE
+- README.md
+- Rakefile
+- TODO.md
+- app/controllers/elaine_crud/base_controller.rb
+- app/helpers/elaine_crud/base_helper.rb
+- app/helpers/elaine_crud/search_helper.rb
+- app/javascript/controllers/dropdown_controller.js
+- app/views/elaine_crud/base/_edit_row.html.erb
+- app/views/elaine_crud/base/_export_button.html.erb
+- app/views/elaine_crud/base/_foreign_key_select_refresh.html.erb
+- app/views/elaine_crud/base/_form.html.erb
+- app/views/elaine_crud/base/_form_fields.html.erb
+- app/views/elaine_crud/base/_index_table.html.erb
+- app/views/elaine_crud/base/_modal.html.erb
+- app/views/elaine_crud/base/_pagination.html.erb
+- app/views/elaine_crud/base/_per_page_selector.html.erb
+- app/views/elaine_crud/base/_search_bar.html.erb
+- app/views/elaine_crud/base/_show_details.html.erb
+- app/views/elaine_crud/base/_view_row.html.erb
+- app/views/elaine_crud/base/edit.html.erb
+- app/views/elaine_crud/base/index.html.erb
+- app/views/elaine_crud/base/new.html.erb
+- app/views/elaine_crud/base/new_modal.html.erb
+- app/views/elaine_crud/base/not_found.html.erb
+- app/views/elaine_crud/base/show.html.erb
+- docs/ARCHITECTURE.md
+- docs/CSS_GRID_LAYOUT.md
+- docs/DEMO.md
+- docs/DSL_EXAMPLES.md
+- docs/FOREIGN_KEY_EXAMPLE.rb
+- docs/FOREIGN_KEY_SUPPORT.md
+- docs/HAS_MANY_IMPLEMENTATION.md
+- docs/LAYOUT_EXAMPLES.md
+- docs/TROUBLESHOOTING.md
+- elaine_crud.gemspec
+- lib/elaine_crud.rb
+- lib/elaine_crud/dsl_methods.rb
+- lib/elaine_crud/engine.rb
+- lib/elaine_crud/export_handling.rb
+- lib/elaine_crud/field_configuration.rb
+- lib/elaine_crud/field_configuration_methods.rb
+- lib/elaine_crud/layout_calculation.rb
+- lib/elaine_crud/parameter_handling.rb
+- lib/elaine_crud/record_fetching.rb
+- lib/elaine_crud/relationship_handling.rb
+- lib/elaine_crud/routing.rb
+- lib/elaine_crud/search_and_filtering.rb
+- lib/elaine_crud/sorting_concern.rb
+- lib/elaine_crud/version.rb
+- lib/tasks/demo.rake
+- lib/tasks/spec.rake
+homepage: https://github.com/garo/elaine_crud
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/garo/elaine_crud
+  source_code_uri: https://github.com/garo/elaine_crud
+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.7
+specification_version: 4
+summary: A Rails engine for generating CRUD UIs for ActiveRecord models
+test_files: []