early_bird 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 11a2fe291571c28805e17591fb53da82eaa775691bc402299fd8ddac2a501863
+  data.tar.gz: f57f2c41713fdf1ead723ed5a51953589040d482994bf080f921abd19b290133
+SHA512:
+  metadata.gz: 94f5c6384a03a83f1138b5f688cc36f0c986eb12ef4d72a6edb0b52aaa9ed8cf6211dc11ef4cd1855bc1199d50d87d5eb2f406e693ef25090310e6152d3607ea
+  data.tar.gz: 33ea58143db1c5e695588cca8993d0b8d9760700f73c0e2fa68b0bc104bfea72efccf118c042b7f0e12397fbc118ed18f59c7491f2022d51b56eb1af8b5e45b1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2023 Carl Dawson
+
+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,65 @@
+# EarlyBird
+
+A very simple Gem to add waitlist functionality to a WIP Rails app.
+
+## Usage
+Follow the installation instructions and you're good to go!
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "early_bird"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install early_bird
+```
+
+Then install the migrations:
+```bash
+$ bin/rails early_bird:install:migrations
+```
+
+And migrate the database:
+```bash
+$ bin/rails db:migrate
+```
+
+EarlyBird requires both new and show views:
+```ruby
+# app/views/early_bird/submissions/new.html.erb
+<%= form_with(model: @submission) do |form| %>
+  <%= form.email_field :email, placeholder: "Your email" %>
+  <%= form.submit "Join the Waitlist" %>
+<% end %>
+```
+
+```ruby
+# app/views/early_bird/submissions/show.html.erb
+<p>Thank you! <%= @submission.email %> has been added to the waitlist!</p>
+```
+
+Then mount the engine in your routes.rb file:
+```ruby
+mount EarlyBird::Engine => "/"
+```
+
+And (optionally) prevent access to the rest of the app while you're building it:
+```ruby
+class ApplicationController < ActionController::Base
+  http_basic_authenticate_with name: "dev", password: "secret"
+end
+``` 
+
+## Contributing
+Contributions welcome
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/assets/config/early_bird_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/early_bird .css

data/app/assets/stylesheets/early_bird/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/early_bird/application_controller.rb

@@ -0,0 +1,4 @@
+module EarlyBird
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/early_bird/submissions_controller.rb

@@ -0,0 +1,26 @@
+module EarlyBird
+  class SubmissionsController < ApplicationController
+    def show 
+      @submission = Submission.find(params[:id])
+    end
+
+    def new
+      @submission = Submission.new
+    end
+
+    def create
+      @submission = Submission.find_or_initialize_by(submission_params)
+      if @submission.save
+        redirect_to @submission
+      else
+        render 'new', status: :unprocessable_entity
+      end
+    end
+
+    private 
+
+    def submission_params
+      params.require(:submission).permit(:email)
+    end
+  end
+end

data/app/helpers/early_bird/application_helper.rb

@@ -0,0 +1,4 @@
+module EarlyBird
+  module ApplicationHelper
+  end
+end

data/app/helpers/early_bird/submissions_helper.rb

@@ -0,0 +1,4 @@
+module EarlyBird
+  module SubmissionsHelper
+  end
+end

data/app/jobs/early_bird/application_job.rb

@@ -0,0 +1,4 @@
+module EarlyBird
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/early_bird/application_mailer.rb

@@ -0,0 +1,6 @@
+module EarlyBird
+  class ApplicationMailer < ActionMailer::Base
+    default from: "from@example.com"
+    layout "mailer"
+  end
+end

data/app/models/early_bird/application_record.rb

@@ -0,0 +1,5 @@
+module EarlyBird
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/early_bird/submission.rb

@@ -0,0 +1,5 @@
+module EarlyBird
+  class Submission < ApplicationRecord
+    validates :email, presence: true, uniqueness: true, format: { with: URI::MailTo::EMAIL_REGEXP }
+  end
+end

data/config/routes.rb

@@ -0,0 +1,4 @@
+EarlyBird::Engine.routes.draw do
+  resources :submissions
+  root "submissions#new"
+end

data/db/migrate/20230928193732_create_early_bird_submissions.rb

@@ -0,0 +1,9 @@
+class CreateEarlyBirdSubmissions < ActiveRecord::Migration[7.0]
+  def change
+    create_table :early_bird_submissions do |t|
+      t.string :email
+
+      t.timestamps
+    end
+  end
+end

data/lib/early_bird/engine.rb

@@ -0,0 +1,5 @@
+module EarlyBird
+  class Engine < ::Rails::Engine
+    isolate_namespace EarlyBird
+  end
+end

data/lib/early_bird/version.rb

@@ -0,0 +1,3 @@
+module EarlyBird
+  VERSION = "0.1.1"
+end

data/lib/early_bird.rb

@@ -0,0 +1,6 @@
+require "early_bird/version"
+require "early_bird/engine"
+
+module EarlyBird
+  # Your code goes here...
+end

data/lib/tasks/early_bird_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :early_bird do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: early_bird
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Carl Dawson
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-09-28 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'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.8
+description:
+email:
+- carldawson@hey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/early_bird_manifest.js
+- app/assets/stylesheets/early_bird/application.css
+- app/controllers/early_bird/application_controller.rb
+- app/controllers/early_bird/submissions_controller.rb
+- app/helpers/early_bird/application_helper.rb
+- app/helpers/early_bird/submissions_helper.rb
+- app/jobs/early_bird/application_job.rb
+- app/mailers/early_bird/application_mailer.rb
+- app/models/early_bird/application_record.rb
+- app/models/early_bird/submission.rb
+- config/routes.rb
+- db/migrate/20230928193732_create_early_bird_submissions.rb
+- lib/early_bird.rb
+- lib/early_bird/engine.rb
+- lib/early_bird/version.rb
+- lib/tasks/early_bird_tasks.rake
+homepage: https://github.com/carldaws/early_bird
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/carldaws/early_bird
+  source_code_uri: https://github.com/carldaws/early_bird
+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.4.10
+signing_key:
+specification_version: 4
+summary: EarlyBird provides simple waitlist functionality to WIP Rails apps
+test_files: []