safe_params 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 92c40ab05cfbf747a0102e131d10e9b38cf7aa9e7f8927606d8c2d8545698a85
+  data.tar.gz: 47c3f973d54db4ff9d991b58aadeb200499e3b88a1ce777e841eec0fa660d62d
+SHA512:
+  metadata.gz: dcf9b7804bdae3758ca84a2ca232b8a8e76b007876d11986ee5fc52c1de9ed5ba2148d8c4b337b4a48b2bc31814add26e9cd11f56059cdcb276ac44c10ded0ee
+  data.tar.gz: 6a9386ed739424f0f6283287a4ce716088d4e56f4b2d5c0df8c3c65e56f37f8807639724351cc0bfcd7f5d444ef1cbf0b5117c8fee33dfa092cad097b9c64c39

data/README.md

@@ -0,0 +1,102 @@
+# SafeParams
+
+A Rails gem that simplifies strong parameter handling by defining permitted attributes in the model.
+
+## Features
+
+- Define strong parameters in the model
+- Supports nested attributes
+- Load attributes from a YAML or JSON config
+- CLI generator for auto-generating safe_params lines
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'safe_params'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install safe_params
+```
+
+## Usage
+
+### In the Model
+
+```ruby
+class User < ApplicationRecord
+  include SafeParams
+  safe_params :name, :email, nested: { address_attributes: [:city, :zip] }
+end
+```
+
+### In the Controller
+
+```ruby
+def user_params
+  safe_params(User)
+end
+```
+
+### YAML Config (Optional)
+
+`config/safe_params.yml`
+
+```yaml
+User:
+  - name
+  - email
+  - address_attributes:
+      - city
+      - zip
+```
+
+### CLI Generator
+
+```bash
+bundle exec ruby -Ilib -r safe_params/cli -e "SafeParams::CLI.start(['generate', 'User'])"
+```
+
+Output:
+
+```ruby
+safe_params :name, :email, :address_attributes => [:city, :zip]
+```
+
+## CLI Usage
+
+After installing the gem, you can use the CLI to generate a `safe_params` line for any ActiveRecord model:
+
+```bash
+safe_params generate User
+```
+
+Output:
+
+```
+safe_params :name, :email, :address_attributes
+```
+
+Show the gem version:
+
+```bash
+safe_params version
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/tewarideepak/safe_params_gem](https://github.com/tewarideepak/safe_params_gem).
+
+## License
+
+This project is licensed under the MIT License.

data/bin/safe_params

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+# CLI entrypoint for SafeParams
+require 'safe_params/cli'
+SafeParams::CLI.start(ARGV)

data/lib/safe_params/cli.rb

@@ -0,0 +1,34 @@
+require 'thor'
+
+# Command-line interface for SafeParams
+module SafeParams
+  class CLI < Thor
+    desc "generate MODEL", "Print a safe_params line for the given ActiveRecord model."
+    def generate(model_name)
+      model_class = Object.const_get(model_name)
+      unless model_class.respond_to?(:columns)
+        warn "Model '#{model_name}' does not support .columns. Is it an ActiveRecord model?"
+        exit(1)
+      end
+      columns = model_class.columns.reject { |c| %w[id created_at updated_at].include?(c.name) }
+      if columns.empty?
+        puts "safe_params"
+      else
+        keys = columns.map { |c| c.name.to_sym }
+        puts "safe_params #{keys.map(&:inspect).join(', ')}"
+      end
+    rescue NameError
+      warn "Model '#{model_name}' not found. Please check the model name."
+      exit(1)
+    rescue => e
+      warn "Unexpected error: #{e.class}: #{e.message}"
+      exit(1)
+    end
+
+    desc "version", "Show SafeParams version"
+    def version
+      require 'safe_params/version'
+      puts "SafeParams v#{SafeParams::VERSION}"
+    end
+  end
+end

data/lib/safe_params/config_loader.rb

@@ -0,0 +1,15 @@
+require "yaml"
+require "json"
+
+module SafeParams
+  module ConfigLoader
+    def self.load_for(model_name)
+      file = Dir[Rails.root.join("config/safe_params.{yml,json}")].first
+      return [] unless file && File.exist?(file)
+
+      data = file.end_with?(".json") ? JSON.parse(File.read(file)) : YAML.load_file(file)
+      data ||= {}
+      data[model_name.to_s] || []
+    end
+  end
+end

data/lib/safe_params/helper.rb

@@ -0,0 +1,25 @@
+module SafeParams
+  module Helper
+    def safe_params(model)
+      name = model.name.underscore
+      config_params = SafeParams::ConfigLoader.load_for(model.name)
+
+      if Array(config_params).any?
+        params.require(name.to_sym).permit(*symbolize_deep(config_params))
+      else
+        permitted = model.respond_to?(:permitted_attributes) ? model.permitted_attributes : nil
+        params.require(name.to_sym).permit(permitted)
+      end
+    end
+
+    private
+
+    def symbolize_deep(obj)
+      case obj
+      when Hash then obj.transform_keys(&:to_sym).transform_values { |v| symbolize_deep(v) }
+      when Array then obj.map { |e| symbolize_deep(e) }
+      else obj
+      end
+    end
+  end
+end

data/lib/safe_params/railtie.rb

@@ -0,0 +1,11 @@
+require 'rails/railtie'
+
+module SafeParams
+  class Railtie < Rails::Railtie
+    initializer 'safe_params.helper' do
+      ActiveSupport.on_load(:action_controller) do
+        include SafeParams::Helper
+      end
+    end
+  end
+end

data/lib/safe_params/version.rb

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

data/lib/safe_params.rb

@@ -0,0 +1,23 @@
+require "safe_params/version"
+require "safe_params/railtie" if defined?(Rails)
+require "safe_params/helper"
+require "safe_params/config_loader"
+require "safe_params/cli"
+
+module SafeParams
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+    def safe_params(*attrs, nested: {})
+      @safe_attrs = attrs.map(&:to_sym)
+      @nested_attrs = nested.transform_keys(&:to_sym)
+    end
+
+    def permitted_attributes
+      nested = @nested_attrs.map { |key, val| { key => val } }
+      @safe_attrs + nested
+    end
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: safe_params
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Deepak Tewari
+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: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: SafeParams is a Rails gem for strong parameter handling. Define permitted
+  attributes in your model or a YAML/JSON config. Supports nested attributes and includes
+  a CLI for generating safe_params lines.
+email:
+- tewarid69@gmail.com
+executables:
+- safe_params
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/safe_params
+- lib/safe_params.rb
+- lib/safe_params/cli.rb
+- lib/safe_params/config_loader.rb
+- lib/safe_params/helper.rb
+- lib/safe_params/railtie.rb
+- lib/safe_params/version.rb
+homepage: https://github.com/tewarideepak/safe_params
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/tewarideepak/safe_params
+  changelog_uri: https://github.com/tewarideepak/safe_params/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/tewarideepak/safe_params/issues
+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.7.1
+specification_version: 4
+summary: Strong parameters helper for Rails. Define permitted attributes in your model
+  or config, with CLI support.
+test_files: []