elaine_crud 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d420c3bf1695740a2f4c8681c27718bf7291439f31ee33024130340052d042eb
+  data.tar.gz: b753bc127d554534dd1afe6d09feedd8239c37e0e535dbc442c18ffb4ecdfd4c
+SHA512:
+  metadata.gz: efb078bfecaa663340d1b093e8aea548f900ee3fac8bd2823d00ebb5e21c628885e95b1df9ffe85cb86b57d8df6042448d303d1f45b85c40581db8ac682f5f51
+  data.tar.gz: 4b58dd75dd0d3a672c2e08fc0d8cdf18238c874b9926f808253552ccfdc727bf1f1958942aabf3977eccc65e69751de4e3e5c904369232e0765b0a9557e0852c

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--color
+--format documentation

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Juho Mäkinen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,225 @@
+# ElaineCrud
+
+A Rails engine for rapidly generating CRUD interfaces for ActiveRecord models with minimal configuration.
+
+## Features
+
+- ✅ **Zero Configuration**: Works out of the box with any ActiveRecord model
+- ✅ **Minimal Code**: Just specify model and permitted params
+- ✅ **Modern UI**: Clean, responsive interface with TailwindCSS
+- ✅ **Extensible**: Override any view or behavior in your host app
+- ✅ **Rails Conventions**: Follows standard Rails patterns
+
+## Installation
+
+Add to your `Gemfile`:
+
+```ruby
+gem 'elaine_crud'
+```
+
+Then run:
+```bash
+bundle install
+```
+
+## Quick Start
+
+### 1. Create a Controller
+
+```ruby
+class PeopleController < ElaineCrud::BaseController
+  layout 'application'  # Specify your app's layout
+  
+  model Person
+  permit_params :name, :email, :phone, :active
+end
+```
+
+### 2. Add Routes
+
+```ruby
+# config/routes.rb
+resources :people
+```
+
+### 3. Configure TailwindCSS (Important!)
+
+Add the gem's files to your `tailwind.config.js`. You need to include the gem's path in Tailwind's content scanning:
+
+```javascript
+const path = require('path')
+const execSync = require('child_process').execSync
+
+// Get the gem path from bundler
+const gemPath = execSync('bundle show elaine_crud', { encoding: 'utf-8' }).trim()
+
+module.exports = {
+  content: [
+    './app/views/**/*.html.erb',
+    './app/helpers/**/*.rb',
+    './app/assets/stylesheets/**/*.css',
+    './app/javascript/**/*.js',
+    // Add ElaineCrud gem views and helpers
+    path.join(gemPath, 'app/views/**/*.html.erb'),
+    path.join(gemPath, 'app/helpers/**/*.rb')
+  ],
+  // ... rest of your config
+}
+```
+
+### 4. Restart Your Server
+
+```bash
+rails server
+```
+
+Navigate to `/people` and you'll have a fully functional CRUD interface!
+
+## Usage
+
+### Basic Controller
+
+The minimal controller setup:
+
+```ruby
+class ArticlesController < ElaineCrud::BaseController
+  layout 'application'  # Host app controls layout (header/footer/styling)
+  
+  model Article
+  permit_params :title, :content, :published
+end
+```
+
+### DSL Reference
+
+- `model(ModelClass)` - Specify the ActiveRecord model to manage
+- `permit_params(*attrs)` - Define permitted attributes for strong parameters
+- `columns(config)` - (Future) Configure column display options
+
+### Customization
+
+#### Override Views
+
+Create views in your app with the same names to override engine views:
+
+```
+app/views/articles/index.html.erb  # Overrides engine's index view
+```
+
+#### Override Controller Methods
+
+```ruby
+class ArticlesController < ElaineCrud::BaseController
+  model Article
+  permit_params :title, :content, :published
+  
+  private
+  
+  # Custom record fetching with scoping
+  def fetch_records
+    Article.published.order(:title)
+  end
+  
+  # Custom column selection
+  def determine_columns
+    %w[title published created_at]
+  end
+end
+```
+
+#### Custom Helpers
+
+Override the display helper in your application:
+
+```ruby
+# app/helpers/application_helper.rb
+def display_column_value(record, column)
+  case column
+  when 'published'
+    record.published? ? '📘 Published' : '📝 Draft'
+  else
+    super # Call the engine's helper
+  end
+end
+```
+
+## Requirements
+
+- Rails 6.0+
+- TailwindCSS (for styling)
+
+## Examples
+
+### Complete Example: Managing Blog Posts
+
+```ruby
+# app/controllers/posts_controller.rb
+class PostsController < ElaineCrud::BaseController
+  layout 'application'  # Use your app's layout
+  
+  model Post
+  permit_params :title, :content, :published, :category_id
+  
+  private
+  
+  def fetch_records
+    Post.includes(:category).order(created_at: :desc)
+  end
+end
+
+# config/routes.rb
+resources :posts
+
+# Navigate to /posts for instant CRUD interface
+```
+
+### Example Output
+
+The generated interface includes:
+- **Index Page**: Responsive table with all records
+- **Smart Formatting**: Dates, booleans, and nil values formatted nicely
+- **Action Buttons**: Edit and Delete functionality
+- **Empty States**: Helpful messages when no records exist
+- **Modern Styling**: Clean TailwindCSS design
+
+## Architecture
+
+ElaineCrud follows a **separation of concerns** approach:
+
+- **Engine provides**: CRUD logic, data formatting, content templates
+- **Host app provides**: Layout, styling, HTML structure, navigation
+
+### Layout Control
+
+The gem doesn't impose any layout - your app controls the HTML structure:
+
+```ruby
+class UsersController < ElaineCrud::BaseController
+  layout 'admin'        # Use admin layout
+  # or layout 'public'  # Use public layout
+  # or layout false     # No layout (API mode)
+  
+  model User
+  permit_params :name, :email
+end
+```
+
+This means:
+- ✅ **Your app controls**: Headers, footers, navigation, CSS frameworks
+- ✅ **Engine provides**: Table content, buttons, data formatting
+- ✅ **Zero view files needed**: No templates to create in your app
+
+See [ARCHITECTURE.md](docs/ARCHITECTURE.md) for detailed technical documentation.
+
+## Contributing
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Add tests
+5. Submit a pull request
+
+## License
+
+MIT License. See [LICENSE](LICENSE) for details.

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+# Load demo tasks
+Dir.glob('lib/tasks/*.rake').each { |r| load r }
+
+task default: :spec