active_crud 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9c7383306d45a72f92d30954133357283f34123c731913f8329c92255eea8cd2
+  data.tar.gz: d67f6e61e4326ac3ecf58efdae75f25b1342a5f1fc3a60f50ffe1d85a91e42b3
+SHA512:
+  metadata.gz: abe464f5bfadceaecedd58c0eb72245abe796e5578ef91c4c8e8ffd16a502b603f8118c4a9d8e2692701bf986cf42030038d56ed1da04021cccde43bb9742ab6
+  data.tar.gz: fc2ba0977f7d3405350be57b148008a1baf9cc2aebb39f55f350d4a0e80308f48160b323e2cd399fb41036abae1172e469cd3d0fe9cf88be2986529094cd8e5f

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-05-26
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at nishi.sharma01@nagarro.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in active_crud.gemspec
+gemspec
+
+gem "rake", "~> 13.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 nishikant-s
+
+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,220 @@
+The ActiveCrud gem is a utility library for performing common data operations in Rails applications. It provides convenient methods for creating records, retrieving records, updating records, deleting records, sorting records, paginating records, and searching records.
+
+## Features
+
+- CRUD operations: Create, retrieve, update, and delete records.
+- Sorting: Sort records based on column names and directions.
+- Pagination: Display a limited number of records per page.
+- Searching: Search records based on specific parameters.
+
+## Installation
+
+Add the ActiveCrud gem to your Gemfile:
+
+```ruby
+gem 'active_crud' 
+```
+### Dependencies
+For Pagination Use Gem 'will_paginate'
+```ruby
+gem 'will_paginate' 
+```
+
+Then, run the following command to install the gem:
+
+```ruby
+bundle install
+```
+# Features
+### Creating a Record
+To create a record, use the ActiveCrud.create_record method:
+```ruby
+record_params = { attribute1: value1, attribute2: value2, ... }
+result = ActiveCrud.create_record(ModelClass, record_params)
+```
+The create_record method returns a result hash containing the following keys:
+:message if the record is created successfully, along with the created record.
+:error if the record fails to create, along with the validation errors.
+
+### Retrieving All Records
+To retrieve all records of a model, use the ActiveCrud.retrieve_all_records method:
+```ruby
+records = ActiveCrud.retrieve_all_records(ModelClass)
+```
+This method returns a collection of all records for the specified model.
+
+### Retrieving a Specific Record
+To retrieve a specific record by its ID, use the ActiveCrud.retrieve_record method:
+```ruby
+result = ActiveCrud.retrieve_record(ModelClass, id)
+```
+The retrieve_record method returns the found record if it exists, or an error message if the record was not found.
+
+### Updating a Record
+To update a record with new parameters, use the ActiveCrud.update_record method:
+```ruby
+record_params = { attribute1: new_value1, attribute2: new_value2, ... }
+result = ActiveCrud.update_record(ModelClass, id, record_params)
+```
+The update_record method returns a result hash containing the following keys:
+:message if the record is updated successfully, along with the updated record.
+:error if the record fails to update, along with the validation errors.
+### Deleting a Record
+To delete a record by its ID, use the ActiveCrud.delete_record method:
+```ruby
+result = ActiveCrud.delete_record(ModelClass, id)
+```
+The delete_record method returns a result hash containing the following keys:
+:message if the record is deleted successfully.
+:error if the record fails to delete.
+### Sorting Records
+To sort records based on a column name and direction, use the ActiveCrud.sort_records method:
+```ruby
+sorted_records = ActiveCrud.sort_records(ModelClass, column, direction)
+```
+The sort_records method returns a collection of records sorted based on the specified column name and direction.
+
+### Paginating Records
+To paginate records and display a limited number of results per page, use the ActiveCrud.paginate_records method:
+```ruby
+paginated_records = ActiveCrud.paginate_records(ModelClass, page, per_page)
+```
+The paginate_records method returns a collection of records for the specified page number and number of records per page.
+
+### Searching Records
+To search records based on specific parameters, use the ActiveCrud.search_records method:
+```ruby
+search_params = { attribute1: value1, attribute2: value2, ... }
+searched_records
+```
+
+# Working Example with real Rails Application
+#### Gemfile
+gem 'active_crud'
+
+#### app/models/user.rb
+```ruby
+class User < ApplicationRecord
+  validates :first_name, :last_name, :email, :password, presence: true
+  validates :email, uniqueness: true
+end
+```
+#### app/controllers/users_controller.rb
+```ruby
+class UsersController < ApplicationController
+  def index
+    @users = ActiveCrud.retrieve_all_records(User)
+    if params[:search].present?
+      @users = ActiveCrud.search_records(@users, %w[first_name last_name],
+                                         sanitize_params(params[:search]))
+    end
+    if params[:sort].present?
+      @users = ActiveCrud.sort_records(@users, sanitize_params(params[:sort]),
+                                       sanitize_params(params[:direction]))
+    end
+    @users = ActiveCrud.paginate_records(@users, sanitize_params(params[:page]), 10)
+  end
+
+  def new
+    @user = User.new
+  end
+
+  def create
+    result = ActiveCrud.create_record(User, user_params)
+
+    if result[:record]
+      redirect_to result[:record], notice: result[:message]
+    else
+      @user = User.new(user_params)
+      flash.now[:error] = result[:error]
+      render :new
+    end
+  end
+
+  def show
+    @user = ActiveCrud.retrieve_record(User, params[:id])
+    redirect_to users_path, alert: @user[:error] if @user[:error]
+  end
+
+  def edit
+    @user = ActiveCrud.retrieve_record(User, params[:id])
+    redirect_to users_path, alert: @user[:error] if @user[:error]
+  end
+
+  def update
+    result = ActiveCrud.update_record(User, params[:id], user_params)
+
+    if result[:record]
+      redirect_to result[:record], notice: result[:message]
+    else
+      @user = ActiveCrud.retrieve_record(User, params[:id])
+      flash.now[:error] = result[:error]
+      render :edit
+    end
+  end
+
+  def destroy
+    result = ActiveCrud.delete_record(User, params[:id])
+
+    redirect_to users_path, notice: result[:message] if result[:message]
+    redirect_to users_path, alert: result[:error] if result[:error]
+  end
+
+  private
+
+  def sanitize_params(value)
+    value.present? ? Arel.sql(value) : nil
+  end
+
+  def user_params
+    params.require(:user).permit(:first_name, :last_name, :email, :password)
+  end
+end
+```
+
+#### app/views/users/index.html.erb
+```ruby
+<h1>Users</h1>
+<%= form_tag users_path, method: :get do %>
+  <%= text_field_tag :search, params[:search] %>
+  <%= submit_tag "Search" %>
+<% end %>
+
+<table>
+  <thead>
+    <tr>
+      <%= link_to 'First Name', { sort: 'first_name', direction: sort_direction('first_name') } %>
+      <%= link_to 'Last Name', { sort: 'last_name', direction: sort_direction('last_name') } %>
+      <%= link_to 'Email', { sort: 'email', direction: sort_direction('email') } %>
+      <th>Actions</th>
+    </tr>
+  </thead>
+
+  <tbody>
+    <% @users.each do |user| %>
+      <tr>
+        <td><%= user.first_name %></td>
+        <td><%= user.last_name %></td>
+        <td><%= user.email %></td>
+        <td>
+          <%= link_to 'Show', user_path(user) %>
+          <%= link_to 'Edit', edit_user_path(user) %>
+          <%= link_to "Delete", user_path(user), method: :delete, data: { turbo_method: :delete, turbo_confirm: 'Are you sure?' }, class: 'btn btn-danger' %>
+
+        </td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>
+<%= will_paginate %>
+
+<p>
+  <%= link_to 'New User', new_user_path %>
+</p>
+```
+#### app/helpers/application_helper.rb
+```ruby
+def sort_direction(column)
+    column == params[:sort] && params[:direction] == 'asc' ? 'desc' : 'asc'
+end
+```

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/lib/active_crud/version.rb

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

data/lib/active_crud.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require_relative 'active_crud/version'
+require 'will_paginate'
+
+module ActiveCrud
+  class Error < StandardError; end
+
+  def self.create_record(model, record_params)
+    record = model.new(record_params)
+
+    if record.save
+      { message: 'Record created successfully', record: record }
+    else
+      { error: 'Failed to create record', errors: record.errors }
+    end
+  end
+
+  def self.retrieve_all_records(model)
+    model.all
+  end
+
+  def self.retrieve_record(model, id)
+    model.find(id)
+  rescue ActiveRecord::RecordNotFound
+    { error: 'Record not found' }
+  end
+
+  def self.update_record(model, id, params)
+    record = model.find(id)
+
+    if record.update(params)
+      { message: 'Record updated successfully', record: record }
+    else
+      { error: 'Failed to update record', errors: record.errors }
+    end
+  rescue ActiveRecord::RecordNotFound
+    { error: 'Record not found' }
+  end
+
+  def self.delete_record(model, id)
+    record = model.find(id)
+
+    if record.destroy
+      { message: 'Record deleted successfully' }
+    else
+      { error: 'Failed to delete record' }
+    end
+  rescue ActiveRecord::RecordNotFound
+    { error: 'Record not found' }
+  end
+
+  def self.sort_records(model, attribute, order = 'asc')
+    model.order(attribute => order)
+  end
+
+  def self.paginate_records(model, page, per_page)
+    page = page.to_i.positive? ? page.to_i : 1
+    model.paginate(page: page, per_page: per_page)
+  end
+
+  def self.search_records(model, attribute_names, search, model_name = nil)
+    model_name ||= model.name
+    conditions = []
+
+    attribute_names.each do |attribute_name|
+      conditions << "#{model_name.downcase.pluralize}.#{attribute_name} LIKE '%#{search}%'" if search.present?
+    end
+
+    if conditions.present?
+      model.where(conditions.join(' OR '))
+    else
+      model.all
+    end
+  end
+end

data/sig/active_crud.rbs

@@ -0,0 +1,4 @@
+module ActiveCrud
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: active_crud
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- nishienquiry
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-05-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  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: will_paginate
+  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: ransack
+  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'
+description: https://github.com/nishienquiry/active_crud
+email:
+- nishi.enquiry@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/active_crud.rb
+- lib/active_crud/version.rb
+- sig/active_crud.rbs
+homepage: https://rubygems.org/gems/active_crud
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://rubygems.org/gems/active_crud
+  source_code_uri: https://github.com/nishienquiry/active_crud
+  changelog_uri: https://github.com/nishienquiry/active_crud
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: https://github.com/nishienquiry/active_crud
+test_files: []