RubyGems - rails_tipjar - Versions diffs - 1.0.1 → 1.0.4 - Mend

rails_tipjar 1.0.1 → 1.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (11) hide show

checksums.yaml +4 -4
data/README.md +16 -87
data/app/helpers/tipjar_helper.rb +55 -66
data/blog_post.md +28 -0
data/index.html +803 -0
data/lib/rails_tipjar/version.rb +1 -1
data/lib/rails_tipjar.rb +0 -14
metadata +4 -5
data/lib/generators/tipjar/install/install_generator.rb +0 -103
data/lib/generators/tipjar/install/templates/tipjar.rb +0 -64
data/lib/rails_tipjar/configuration.rb +0 -171

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2acacf788da12d40f7f2b20ae9042e0adf416bb17475c20cd309a737120143fa
-  data.tar.gz: ed97fb19a2935a38bc26c29c86be548c1d33a08c33081dfc336e88af83957a36
+  metadata.gz: a9ed6ef66307fcfc411261085d63d47db03e5b1eec57c18ac9ce09d00e2b9b88
+  data.tar.gz: 8206ee7011c23b59e0038ac580e8fe732cedc9c4fb5e284876b895c965c96eb1
 SHA512:
-  metadata.gz: 604ce459a6e71e0b16aef786e0c146b01c3fe4805dbf3fbf880e8df105168520b8fe967dbc8dd195a6efd16622cf0be56c9edee722073e9fb88873b293f5563c
-  data.tar.gz: 9adf68a419979b2d4e5e8a96d3ec92a0cf4135e074cf4c03c6d17879d056cbd08861d12b5e1561a5436c7af5d4f7d668279b3976684f65fb6e4fa5f117a67b20
+  metadata.gz: f604fb762bd7950cf3d4eca97b1a98f956910b4239330a1d49e2a1c1ae6ea245bc9b954e1a7fcb0ffb06c798feafcaaaabb1208a09384ac47c0189fdeacc36f4
+  data.tar.gz: afaad68332124f981074c91c9e95e1ee144a1ba75b05d0b26b0e7f1cc3d0d0aaaaa1eed42b6e536cbff16b4b4e488eb1ea27831a98ddc7f907201703c497a9b4

data/README.md CHANGED Viewed

@@ -2,6 +2,11 @@
 A reusable, customizable tip jar feature for Rails applications. Add a beautiful tip jar to any Rails app with just a few lines of code! Works with any payment provider - Stripe, PayPal, Buy Me a Coffee, Ko-fi, or any custom payment link.
+Hat example:
+|Standard|Hovered|
+|--------|-------|
+|<img width="63" height="66" alt="Screenshot 2025-09-12 at 10 22 51 AM" src="https://github.com/user-attachments/assets/56ebad46-ce77-4a26-8d93-525ecea8ef6a" />|<img height="66" alt="Screenshot 2025-09-12 at 10 20 50 AM" src="https://github.com/user-attachments/assets/beebe18e-a5bb-486b-835b-0caf18813781" />|
 ## Features
 - 🎨 Customizable floating button with multiple icon options (coffee, heart, star, dollar, jar)
@@ -11,7 +16,6 @@ A reusable, customizable tip jar feature for Rails applications. Add a beautiful
 - 📱 Fully responsive design with inline styles (no CSS dependencies)
 - 🎯 Multiple positioning options (bottom-right, bottom-left, top-right, top-left)
 - 🌙 Light/Dark theme support for modal
-- 📊 Built-in analytics tracking
 - ⚡ Stimulus.js powered interactions
 - 🔧 Zero configuration to get started
 - 🚀 Simple mode: Direct link without modal
@@ -34,21 +38,12 @@ Add this gem to your Rails application's Gemfile:
 # From RubyGems
 gem 'rails_tipjar'
-# Or from GitHub for latest features
-gem 'rails_tipjar', git: 'https://github.com/justinpaulson/rails_tipjar'
-```
 Then execute:
 ```bash
 bundle install
 ```
-Optionally run the generator (only needed for backwards compatibility with v0.3.0 and earlier):
-```bash
-rails generate tipjar:install
-```
 ## Quick Start
 ### 1. Create Payment Links
@@ -79,7 +74,7 @@ Add directly to any view:
 <!-- With all customization options -->
 <%= tip_jar payment_link: 'https://your.payment.link',
             message: 'Support This Project',     # Text shown on hover
-            icon: :heart,                        # :coffee, :heart, :star, :dollar, :jar, or custom SVG
+            icon: :heart,                        # :coffee, :heart, :star, :dollar, :jar, :hat, or custom SVG
             position: :bottom_right,              # :bottom_right, :bottom_left, :top_right, :top_left
             color: '#8b5cf6',                    # Button background color
             text_color: '#ffffff',               # Button text color
@@ -104,8 +99,7 @@ Add directly to any view:
               { amount: 10, label: '$10', default: true },
               { amount: 25, label: '$25', default: false }
             ],
-            theme: :light,                       # :light, :dark, :auto
-            analytics_enabled: true %>
+            theme: :light %>                     # :light, :dark, :auto
 <!-- Force modal mode with single link -->
 <%= tip_jar payment_link: 'https://your.payment.link',
@@ -125,7 +119,7 @@ Add to `app/views/layouts/application.html.erb`:
   </head>
   <body>
     <%= yield %>
     <!-- Add floating tip jar button -->
     <%= tip_jar payment_link: 'https://your.payment.link',
                 position: :bottom_right %>
@@ -135,10 +129,6 @@ Add to `app/views/layouts/application.html.erb`:
 That's it! You now have a working tip jar on your site.
-## Helper Options
-All configuration is done directly in the view helper:
 ### Common Options
 | Option | Description | Default | Values |
@@ -146,7 +136,7 @@ All configuration is done directly in the view helper:
 | `payment_link` | Single payment URL for simple mode | - | URL string |
 | `payment_links` | Hash of payment URLs for modal mode | - | Hash with keys like `:small`, `:medium`, `:large` |
 | `message` / `button_text` | Text shown on button (on hover) | `"Tip Jar"` | String |
-| `icon` | Button icon | `:jar` | `:coffee`, `:heart`, `:star`, `:dollar`, `:jar`, or custom SVG |
+| `icon` | Button icon | `:jar` | `:coffee`, `:heart`, `:star`, `:dollar`, `:jar`, `:hat`, or custom SVG |
 | `position` | Button position on screen | `:bottom_right` | `:bottom_right`, `:bottom_left`, `:top_right`, `:top_left` |
 | `color` | Button background color | `"#3b82f6"` | Hex color string |
 | `text_color` | Button text color | `"#ffffff"` | Hex color string |
@@ -163,7 +153,6 @@ All configuration is done directly in the view helper:
 | `modal_description` | Modal description text | `"Your support helps..."` |
 | `theme` | Modal color theme | `:light` |
 | `custom_amounts` | Array of amount options | See example below |
-| `analytics_enabled` | Track user interactions | `false` |
 ### Custom Amounts Example
@@ -175,36 +164,6 @@ custom_amounts: [
   { amount: 50, label: "$50", default: false }
 ]
-## Additional Helpers
-### Custom Tip Links
-```erb
-<!-- Create a custom tip link (requires initializer config) -->
-<%= tipjar_link "Support this project", amount: :large %>
-<!-- With custom styling -->
-<%= tipjar_link "Tip $5", amount: :small, class: "btn btn-primary" %>
-```
-### Modal Only
-```erb
-<!-- Render just the modal (for custom triggers) -->
-<%= tipjar_modal %>
-```
-## Backwards Compatibility
-If you're upgrading from v0.3.0 or earlier and want to keep using the initializer-based configuration:
-```erb
-<!-- Use the deprecated tipjar_button helper -->
-<%= tipjar_button %>
-```
-This requires having a `config/initializers/tipjar.rb` file. We recommend migrating to the new `tip_jar` helper with inline options for easier customization.
 ## Styling
 As of v0.2.0, the gem is fully self-contained with inline styles - no external CSS required! The button works out of the box without any app-side styling.
@@ -236,20 +195,6 @@ As of v0.2.0, the gem is fully self-contained with inline styles - no external C
 .tipjar-submit-button { }
 ```
-## Analytics
-When `analytics_enabled` is true, the following events are tracked:
-- `tipjar_loaded` - Button loaded on page
-- `tipjar_modal_opened` - User opened the modal
-- `tipjar_amount_selected` - User selected an amount
-- `tipjar_submitted` - User clicked to proceed to payment
-Works automatically with:
-- Google Analytics 4 (gtag)
-- Plausible Analytics
-- Custom events via `document.addEventListener('tipjar:event', ...)`
 ## Development
 After checking out the repo:
@@ -267,17 +212,21 @@ gem 'rails_tipjar', path: '../path/to/rails_tipjar'
 ## Icon Options
-The gem includes 5 built-in icons:
+The gem includes 6 built-in icons:
 - `:jar` - Tip jar with animated coin (default)
-- `:coffee` - Coffee cup
+- `:coffee` - Coffee cup with steam animation
 - `:heart` - Heart shape
 - `:star` - Star
 - `:dollar` - Dollar sign in circle
+- `:hat` - Upside-down busker hat with animated coin drop
 You can also provide a custom SVG string for complete customization.
 ## Version History
+- **v1.0.4** - Fixed Safari animation rendering issue with black backgrounds (added fill to animated coins)
+- **v1.0.3** - Removed deprecated features: analytics, backwards compatibility helpers (tipjar_button, tipjar_link, tipjar_modal), and generators
+- **v1.0.2** - Added new `:hat` icon option (busker-style upside-down hat with animated coin drop)
 - **v1.0.1** - Changed default button text to "Tip Jar" and default icon to jar
 - **v1.0.0** - Stable release with all configuration in view helper options (no initializer needed!)
 - **v0.3.0** - Made payment provider agnostic (works with any payment link service)
@@ -286,30 +235,10 @@ You can also provide a custom SVG string for complete customization.
 - **v0.2.0** - Made gem fully self-contained with inline styles
 - **v0.1.0** - Initial release
-## Troubleshooting
-### Button not appearing
-1. Check that `<%= tipjar_button %>` is in your layout
-2. Verify Stimulus is working in your app
-3. Check browser console for JavaScript errors
-### Modal not opening (modal mode only)
-1. Ensure Stimulus controller is registered
-2. Verify no z-index conflicts with your existing styles
-3. Make sure `use_modal = true` if using single payment_link
-### Payment links not working
-1. Ensure your payment links are active with your provider
-2. Check that URLs are correctly configured in initializer
-3. Test links directly in browser
 ## Contributing
 Bug reports and pull requests are welcome on GitHub at https://github.com/justinpaulson/rails_tipjar.
 ## License
-The gem is available as open source under the terms of the MIT License.
+The gem is available as open source under the terms of the MIT License.

data/app/helpers/tipjar_helper.rb CHANGED Viewed

@@ -25,7 +25,6 @@ module TipjarHelper
       { amount: 25, label: "$25", default: false },
       { amount: 50, label: "$50", default: false }
     ]
-    analytics_enabled = options[:analytics_enabled] || false
     # Ensure color has # prefix
     color = "##{color}" unless color.start_with?('#')
@@ -45,7 +44,6 @@ module TipjarHelper
         custom_amounts: custom_amounts,
         button_class: custom_class,
         z_index: z_index,
-        analytics_enabled: analytics_enabled,
         color: color,
         text_color: text_color,
         pulse: pulse
@@ -68,35 +66,6 @@ module TipjarHelper
       raise ArgumentError, "You must provide either :payment_link or :payment_links option to tip_jar helper"
     end
   end
-  # Deprecated - kept for backwards compatibility
-  def tipjar_button(options = {})
-    config = RailsTipjar.config if defined?(RailsTipjar)
-    if config && (config.payment_link || config.payment_links.any?)
-      # Use config from initializer for backwards compatibility
-      tip_jar(
-        payment_link: config.payment_link,
-        payment_links: config.payment_links.any? ? config.payment_links : nil,
-        use_modal: config.use_modal,
-        position: options[:position] || config.position,
-        icon: config.icon,
-        button_text: config.button_text,
-        color: config.color,
-        text_color: config.text_color,
-        pulse: config.pulse,
-        z_index: options[:z_index] || config.z_index,
-        class: options[:class] || config.button_class,
-        modal_title: config.modal_title,
-        modal_description: config.modal_description,
-        custom_amounts: config.custom_amounts,
-        theme: config.theme,
-        analytics_enabled: config.analytics_enabled
-      )
-    else
-      raise ArgumentError, "tipjar_button requires configuration. Use tip_jar helper with options instead."
-    end
-  end
   private
@@ -149,8 +118,7 @@ module TipjarHelper
                   tipjar_theme_value: options[:theme],
                   tipjar_modal_title_value: options[:modal_title],
                   tipjar_modal_description_value: options[:modal_description],
-                  tipjar_custom_amounts_value: options[:custom_amounts].to_json,
-                  tipjar_analytics_enabled_value: options[:analytics_enabled]
+                  tipjar_custom_amounts_value: options[:custom_amounts].to_json
                 } do
       render partial: "tipjar/button", locals: {
         position: options[:position],
@@ -194,38 +162,6 @@ module TipjarHelper
     end
   end
-  def tipjar_link(text = nil, options = {})
-    config = RailsTipjar.config
-    text ||= config.button_text
-    amount = options[:amount] || :medium
-    link_url = if amount.is_a?(Symbol)
-      config.payment_links[amount]
-    else
-      config.payment_links[:custom] || config.payment_links[:medium]
-    end
-    link_options = {
-      target: "_blank",
-      rel: "noopener",
-      class: "tipjar-link #{options[:class]}",
-      data: {
-        tipjar_amount: amount,
-        tipjar_analytics: config.analytics_enabled
-      }
-    }
-    link_to text, link_url, link_options.merge(options.except(:amount, :class))
-  end
-  def tipjar_modal(options = {})
-    config = RailsTipjar.config
-    render partial: "tipjar/modal", locals: {
-      config: config,
-      options: options
-    }
-  end
   def config_position_classes(position)
     case position
@@ -355,7 +291,60 @@ module TipjarHelper
         <ellipse cx="13" cy="19" rx="1.3" ry="0.4" stroke-linecap="round"/>
         <!-- Falling coin - starts above jar outside -->
         <g class="tipjar-coin-drop-new">
-          <ellipse cx="12" cy="1.5" rx="1.5" ry="0.5" stroke-linecap="round"/>
+          <ellipse cx="12" cy="1.5" rx="1.5" ry="0.5" stroke-linecap="round" fill="currentColor"/>
+        </g>
+      </svg>'
+    when :hat
+      '<svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor" class="w-6 h-6">
+        <defs>
+          <style>
+            @keyframes hat-coin-drop {
+              0% {
+                transform: translateY(0px);
+                opacity: 0;
+              }
+              10% {
+                opacity: 1;
+                transform: translateY(1px);
+              }
+              50% {
+                transform: translateY(8px);
+                opacity: 1;
+              }
+              80% {
+                transform: translateY(13px);
+                opacity: 1;
+              }
+              100% {
+                transform: translateY(14px);
+                opacity: 0;
+              }
+            }
+            .hat-coin-drop {
+              animation: hat-coin-drop 2.5s ease-in infinite;
+            }
+          </style>
+        </defs>
+        <!-- Upside down fedora/trilby style hat -->
+        <!-- Wide brim at top (since upside down) -->
+        <ellipse cx="12" cy="8" rx="9" ry="2" stroke-linecap="round" stroke-linejoin="round" fill="none"/>
+        <!-- Brim edge detail -->
+        <path stroke-linecap="round" stroke-linejoin="round" fill="none" d="M3 8c0 0.5 0 0.5 0 0.5"/>
+        <path stroke-linecap="round" stroke-linejoin="round" fill="none" d="M21 8c0 0.5 0 0.5 0 0.5"/>
+        <!-- Crown of hat (narrower at bottom) -->
+        <path stroke-linecap="round" stroke-linejoin="round" fill="none" d="M6.5 8.5c0 0 0.5 8 1.5 9.5c0.5 0.75 1.5 1 4 1s3.5-0.25 4-1c1-1.5 1.5-9.5 1.5-9.5"/>
+        <!-- Inner opening visible from top -->
+        <ellipse cx="12" cy="9" rx="5.5" ry="1.3" stroke-linecap="round" stroke-linejoin="round" fill="none" opacity="0.4"/>
+        <!-- Hat crease/pinch detail -->
+        <path stroke-linecap="round" stroke-linejoin="round" fill="none" d="M10 10c0 0 0.2 5 0.3 6" opacity="0.3"/>
+        <path stroke-linecap="round" stroke-linejoin="round" fill="none" d="M14 10c0 0 -0.2 5 -0.3 6" opacity="0.3"/>
+        <!-- Coins sitting in the hat -->
+        <ellipse cx="11" cy="16" rx="1.3" ry="0.4" stroke-linecap="round" fill="none"/>
+        <ellipse cx="13" cy="15.5" rx="1.3" ry="0.4" stroke-linecap="round" fill="none"/>
+        <ellipse cx="12" cy="17" rx="1.2" ry="0.35" stroke-linecap="round" fill="none"/>
+        <!-- Animated falling coin -->
+        <g class="hat-coin-drop">
+          <ellipse cx="12" cy="3" rx="1.5" ry="0.5" stroke-linecap="round" fill="currentColor"/>
         </g>
       </svg>'
     else

data/blog_post.md ADDED Viewed

@@ -0,0 +1,28 @@
+# Content Busking: The Ad-Free Revolution We've Been Waiting For! 💎
+Forget everything you know about monetizing your Rails apps – there's a new sheriff in town, and it's bringing busking into the digital age! Rails Tip Jar is the gem that's about to change how we support our favorite developers and content creators. No more intrusive pop-ups, no more tracking cookies, no more selling your soul (and your users' data) to the ad networks. Just a simple, elegant tip button that lets your grateful users show their appreciation with cold, hard cash!
+I'm all in on this tipping revolution, folks. Every time I see this little tip jar icon on a website, my wallet will be unloading itself. Why? Because I know my money is going directly to the developer who put in the work (assuming they aren't also bombarding me with ads). It's personal, it's direct, and it feels *good*. Plus, let's be real – tipping culture isn't going anywhere in the USA, so we might as well embrace it in the digital realm as well! Plus, [no taxes on tips](https://www.congress.gov/bill/119th-congress/senate-bill/129) right??
+The installation is dead simple – just `gem install rails_tipjar`, add a single line to your view, and boom, you're ready to receive the gratitude of the internet. No lengthy terms of service, no revenue sharing agreements, no minimum payout thresholds. Just pure, unadulterated tips flowing directly to you. Long live the tip jar, long live the independent developer, and long live the ad-free internet we all deserve! 🎉
+## Quick Setup Guide
+Getting started with [Rails Tip Jar](https://rubygems.org/gems/rails_tipjar) takes literally 30 seconds:
+1. Add to your Gemfile: `gem 'rails_tipjar'`
+2. Run `bundle install`
+3. Drop this line wherever you want tips: `<%= tip_jar payment_link: 'https://your.payment.link' %>`
+That's it! No configuration files, no initializers, nothing. Want to customize it? Just pass options directly:
+```erb
+<%= tip_jar payment_link: 'https://your.payment.link',
+            message: 'Support my work',      # Custom button text (default: "Tip Jar")
+            icon: :heart,                    # Choose from 5 icons
+            color: '#8b5cf6',                # Custom colors
+            pulse: true,                     # Pulsing animation
+            position: :bottom_left %>        # Position on screen
+```
+The gem handles all the payment provider integration (works with Stripe, PayPal, Ko-fi, Buy Me a Coffee – literally any payment link), and includes beautiful inline styles so it looks perfect out of the box. No CSS dependencies, no JavaScript frameworks needed – just pure Rails helper goodness.