signature_pad_rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 392312070b7cae8b1cfdb32d39adcc84025295c002bcec9f3adc83343dd5f151
+  data.tar.gz: 581ab90b67234b0116a1f8086bde505467ffdff5ce2e09817ff654253db9be6a
+SHA512:
+  metadata.gz: e78879a866ccba70f05a03cf708130c77dd459a8d6c0dab13b70cd1867a723799d94abbee4764084602bbac193c1ddad2dbf60a476e8fbb14e237fe0c7c2fa82
+  data.tar.gz: 5488b5d21a21c3f5b16ea3f97820b8e86bf5b493fd30d72066526cbfe64f1ae2d4189e9610ece7210c0bc389346289db0df401d88282b42a6df79654819030e3

data/README.md

@@ -0,0 +1,281 @@
+# SignaturePadRails
+
+Easy integration of signature_pad.js with Rails applications.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'signature_pad_rails'
+```
+
+And then execute:
+```bash
+$ bundle install
+$ rails generate signature_pad_rails:install
+$ rails db:migrate
+```
+
+## Usage
+
+### 1. Include the concern in your model:
+
+```ruby
+class Swmm < ApplicationRecord
+  include SignaturePadRails::Signable
+end
+```
+
+### 2. Add the signature pad to your form:
+
+```erb
+<%= render 'signature_pad_rails/signature_pad', signable: @swmm %>
+```
+
+### 3. Import the JavaScript in your application.js:
+
+```javascript
+import "signature_pad_rails"
+```
+
+### 4. Permit signature attributes in your controller:
+
+```ruby
+def swmm_params
+  params.require(:swmm).permit(
+    # other params...
+    signature_attributes: [:data]
+  )
+end
+```
+
+### 5. Display signatures:
+
+```erb
+<% if @swmm.signature.present? %>
+  <div class="signature-display">
+    <%= image_tag @swmm.signature.data, alt: "Signature" %>
+  </div>
+<% end %>
+```
+
+## Configuration
+
+You can configure SignaturePadRails in an initializer:
+
+```ruby
+# config/initializers/signature_pad_rails.rb
+SignaturePadRails.configure do |config|
+  config.pad_width = 400
+  config.pad_height = 200
+  config.background_color = 'rgb(255, 255, 255)'
+  config.pen_color = 'rgb(0, 0, 0)'
+  config.min_width = 0.5
+  config.max_width = 2.5
+  config.throttle = 16
+  config.min_distance = 5
+end
+```
+
+## Advanced Usage
+
+### Custom Styling
+
+Add custom CSS to style the signature pad:
+
+```css
+.signature-pad-container {
+  width: 100%;
+  max-width: 600px;
+  margin: 0 auto;
+}
+
+.signature-pad {
+  border: 2px solid #ddd;
+  border-radius: 8px;
+  box-shadow: 0 2px 4px rgba(0,0,0,0.1);
+}
+
+.signature-pad-actions {
+  margin-top: 1rem;
+  display: flex;
+  justify-content: space-between;
+}
+```
+
+### Multiple Signatures
+
+For models with multiple signatures:
+
+```ruby
+class Document < ApplicationRecord
+  has_many :signatures, 
+           class_name: 'SignaturePadRails::Signature', 
+           as: :signable, 
+           dependent: :destroy
+end
+```
+
+### Validation
+
+Add custom validation to ensure signatures are provided:
+
+```ruby
+class Swmm < ApplicationRecord
+  include SignaturePadRails::Signable
+  
+  validates :signature, presence: true, on: :update
+end
+```
+
+## API Reference
+
+### SignaturePadRails::Signable
+
+The main concern that adds signature functionality to your models.
+
+#### Methods
+
+- `signature` - Returns the associated signature
+- `signature_present?` - Returns true if a signature exists
+- `signature_data` - Returns the raw signature data
+
+### SignaturePadRails::Signature
+
+The signature model that stores signature data.
+
+#### Attributes
+
+- `data` - Base64 encoded signature image
+- `signable` - Polymorphic association to the parent model
+- `created_at` - Timestamp when signature was created
+- `updated_at` - Timestamp when signature was last updated
+
+## JavaScript API
+
+The gem provides JavaScript functionality that can be customized:
+
+```javascript
+// Get the signature pad instance
+const signaturePad = document.querySelector('#signature-pad').signaturePad;
+
+// Clear the pad programmatically
+signaturePad.clear();
+
+// Check if empty
+if (signaturePad.isEmpty()) {
+  console.log('No signature');
+}
+
+// Get signature data
+const data = signaturePad.toDataURL();
+```
+
+## Turbo Support
+
+The gem is fully compatible with Turbo. For forms submitted via Turbo:
+
+```erb
+<%= form_with model: @swmm, data: { turbo: true } do |form| %>
+  <%= render 'signature_pad_rails/signature_pad', signable: @swmm, form: form %>
+<% end %>
+```
+
+## Stimulus Integration
+
+For custom Stimulus controllers:
+
+```javascript
+import { Controller } from "@hotwired/stimulus"
+import SignaturePad from "signature_pad"
+
+export default class extends Controller {
+  static targets = [ "canvas", "input" ]
+  
+  connect() {
+    this.signaturePad = new SignaturePad(this.canvasTarget)
+  }
+  
+  clear() {
+    this.signaturePad.clear()
+  }
+  
+  save() {
+    if (!this.signaturePad.isEmpty()) {
+      this.inputTarget.value = this.signaturePad.toDataURL()
+    }
+  }
+}
+```
+
+## Troubleshooting
+
+### Common Issues
+
+1. **Signature not saving**: Ensure you've added `signature_attributes: [:data]` to your strong parameters.
+
+2. **JavaScript not loading**: Make sure you've run `yarn add signature_pad` and imported the JavaScript.
+
+3. **Canvas sizing issues**: The canvas may need to be resized on window resize:
+
+```javascript
+window.addEventListener('resize', () => {
+  // Resize canvas logic
+});
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/yourusername/signature_pad_rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/yourusername/signature_pad_rails/blob/main/CODE_OF_CONDUCT.md).
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Testing
+
+```bash
+bundle exec rspec
+```
+
+To run tests with coverage:
+
+```bash
+COVERAGE=true bundle exec rspec
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the SignaturePadRails project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/yourusername/signature_pad_rails/blob/main/CODE_OF_CONDUCT.md).
+
+## Credits
+
+This gem is built on top of the excellent [signature_pad](https://github.com/szimek/signature_pad) library by Szymon Nowak.
+
+## Support
+
+For bug reports and feature requests, please use the [GitHub issue tracker](https://github.com/yourusername/signature_pad_rails/issues).
+
+## Changelog
+
+See [CHANGELOG.md](CHANGELOG.md) for a list of changes.
+
+## Requirements
+
+- Ruby 2.7.0 or higher
+- Rails 7.0.0 or higher
+- Modern browser with canvas support
+- Node.js and Yarn (for JavaScript dependencies)

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: :rubocop

data/app/models/signature_pad_rails/signature.rb

@@ -0,0 +1,9 @@
+# app/models/signature_pad_rails/signature.rb
+module SignaturePadRails
+  class Signature < ApplicationRecord
+    self.table_name = "signature_pad_rails_signatures"
+    
+    belongs_to :signable, polymorphic: true
+    validates :data, presence: true
+  end
+end

data/app/views/signature_pad_rails/_signature_pad.html.erb

@@ -0,0 +1,15 @@
+# app/views/signature_pad_rails/_signature_pad.html.erb
+<div class="signature-pad-container">
+  <canvas id="signature-pad" class="signature-pad" width="400" height="200"></canvas>
+  
+  <%= form_with(model: signable, local: true, id: 'signature-form') do |form| %>
+    <%= form.fields_for :signature do |signature_form| %>
+      <%= signature_form.hidden_field :data, id: 'signature_data' %>
+    <% end %>
+    
+    <div class="signature-pad-actions">
+      <button id="clear-signature" class="btn btn-secondary">Clear</button>
+      <button id="save-signature" class="btn btn-primary">Save</button>
+    </div>
+  <% end %>
+</div>

data/lib/generators/signature_pad_rails/install/install_generator.rb

@@ -0,0 +1,52 @@
+# lib/generators/signature_pad_rails/install/install_generator.rb
+module SignaturePadRails
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+      
+      def create_migrations
+        rake "signature_pad_rails:install:migrations"
+      end
+      
+      def create_initializer
+        template "initializer.rb", "config/initializers/signature_pad_rails.rb"
+      end
+      
+      def install_javascript
+        create_file "app/javascript/signature_pad_rails.js", <<-JS
+import SignaturePad from 'signature_pad'
+
+document.addEventListener('turbo:load', () => {
+  const canvas = document.querySelector('#signature-pad')
+  
+  if (canvas) {
+    const signaturePad = new SignaturePad(canvas, {
+      backgroundColor: 'rgb(255, 255, 255)'
+    })
+
+    document.querySelector('#clear-signature').addEventListener('click', (e) => {
+      e.preventDefault()
+      signaturePad.clear()
+    })
+
+    document.querySelector('#save-signature').addEventListener('click', (e) => {
+      e.preventDefault()
+      if (signaturePad.isEmpty()) {
+        alert('Please provide a signature first.')
+      } else {
+        const signatureData = signaturePad.toDataURL()
+        document.querySelector('#signature_data').value = signatureData
+        document.querySelector('#signature-form').submit()
+      }
+    })
+  }
+})
+        JS
+      end
+      
+      def add_yarn_package
+        run "yarn add signature_pad"
+      end
+    end
+  end
+end

data/lib/generators/signature_pad_rails/templates/migration.rb

@@ -0,0 +1,11 @@
+# lib/generators/signature_pad_rails/templates/migration.rb
+class CreateSignaturePadRailsSignatures < ActiveRecord::Migration[7.0]
+  def change
+    create_table :signature_pad_rails_signatures do |t|
+      t.text :data
+      t.references :signable, polymorphic: true, null: false
+      
+      t.timestamps
+    end
+  end
+end

data/lib/signature_pad_rails/signable.rb

@@ -0,0 +1,15 @@
+# lib/signature_pad_rails/signable.rb
+module SignaturePadRails
+  module Signable
+    extend ActiveSupport::Concern
+
+    included do
+      has_one :signature, 
+              class_name: 'SignaturePadRails::Signature', 
+              as: :signable, 
+              dependent: :destroy
+      
+      accepts_nested_attributes_for :signature
+    end
+  end
+end

data/lib/signature_pad_rails/version.rb

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

data/lib/signature_pad_rails.rb

@@ -0,0 +1,17 @@
+# lib/signature_pad_rails.rb
+require "signature_pad_rails/version"
+require "signature_pad_rails/engine"
+
+module SignaturePadRails
+end
+
+# lib/signature_pad_rails/engine.rb
+module SignaturePadRails
+  class Engine < ::Rails::Engine
+    isolate_namespace SignaturePadRails
+    
+    initializer "signature_pad_rails.assets" do |app|
+      app.config.assets.precompile += %w( signature_pad_rails/signature_pad.js )
+    end
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: signature_pad_rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- heyjeremy
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-06-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+- !ruby/object:Gem::Dependency
+  name: jsbundling-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'
+description: Easy integration of signature_pad.js with Rails, including models and
+  views
+email:
+- hello@heyjeremy.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- app/models/signature_pad_rails/signature.rb
+- app/views/signature_pad_rails/_signature_pad.html.erb
+- lib/generators/signature_pad_rails/install/install_generator.rb
+- lib/generators/signature_pad_rails/templates/migration.rb
+- lib/signature_pad_rails.rb
+- lib/signature_pad_rails/signable.rb
+- lib/signature_pad_rails/version.rb
+homepage: https://github.com/ohheyjeremy/SignaturePadRails
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ohheyjeremy/SignaturePadRails
+  source_code_uri: https://github.com/ohheyjeremy/SignaturePadRails
+  changelog_uri: https://github.com/ohheyjeremy/SignaturePadRails/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: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: Signature pad integration for Rails applications
+test_files: []