solidus_newsletter 1.0 → 1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b7181ee38f3d6ae3e37561089ad3d4a6f3d9c0f4f2da4a7a2eeb0b2f0eeaf6e
-  data.tar.gz: 82677d2a3786f839cb907d9aed94f837c940fa1ae733c69b98224e559d4348d0
+  metadata.gz: 41468f6f1439adf05a6b7dae4b31fe167caab4dc5514d8d47c601a405df8be21
+  data.tar.gz: 53101a190127763f6c958aa3dda6d0d5019186740a9d0340ac7ca600a71788e3
 SHA512:
-  metadata.gz: 785f34dfa1c29564b687afa7d9a14d38eed374b64ae95382d2d58130360125ecc89e7f3dee1fa8e4bea125f0722c1cd7000cc66dd115c10b9d0c0cb804eb6ba1
-  data.tar.gz: 27700c0900df2675e1fb28783ca5fa68132f6bb815e2939bedc110969e115658fb87c0d9d84520ac3a62faba6445a2bea01047733b05759ba64d6bfe4b1d443d
+  metadata.gz: 6084ba67e4124a99a74478519f47715aa25e93bd87e5af7dd65af73efd87eef880c2e03e9152e2fe53e44ed44af6d249fb7bba9a18a18b6caed1f46a7bb40031
+  data.tar.gz: 1b3c91d263292366da9112d0546a6d66c70fc2ad3cc21c7d9ac57a9799704fa736e4c39522945abdc6f02849b3fe939aef8998ab2a7d3b4d8c4be2b8f039d6cd

data/.circleci/config.yml

@@ -0,0 +1,35 @@
+version: 2.1
+
+orbs:
+  # Always take the latest version of the orb, this allows us to
+  # run specs against Solidus supported versions only without the need
+  # to change this configuration every time a Solidus version is released
+  # or goes EOL.
+  solidusio_extensions: solidusio/extensions@volatile
+
+jobs:
+  run-specs-with-postgres:
+    executor: solidusio_extensions/postgres
+    steps:
+      - solidusio_extensions/run-tests
+  run-specs-with-mysql:
+    executor: solidusio_extensions/mysql
+    steps:
+      - solidusio_extensions/run-tests
+
+workflows:
+  "Run specs on supported Solidus versions":
+    jobs:
+      - run-specs-with-postgres
+      - run-specs-with-mysql
+  "Weekly run specs against master":
+    triggers:
+      - schedule:
+          cron: "0 0 * * 4" # every Thursday
+          filters:
+            branches:
+              only:
+                - master
+    jobs:
+      - run-specs-with-postgres
+      - run-specs-with-mysql

data/.gitignore

@@ -7,9 +7,9 @@
 .project
 .sass-cache
 coverage
-Gemfile.lock
 tmp
 nbproject
 pkg
 *.swp
-spec/dummy
+spec/dummy
+Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,23 @@
+require:
+  - solidus_dev_support/rubocop
+
+inherit_gem:
+  solidus_dev_support: .rubocop.yml
+
+AllCops:
+  Exclude:
+    - spec/dummy/**/*
+    - vendor/**/*
+
+Rails/SkipsModelValidations:
+  Exclude:
+    - db/migrate/**/*
+
+Gemspec/OrderedDependencies:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/MissingRespondToMissing:
+  Enabled: false

data/.ruby-version

@@ -1 +1 @@
-2.3.1
+3.0.0

data/Gemfile

@@ -1,25 +1,52 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
 branch = ENV.fetch('SOLIDUS_BRANCH', 'master')
-gem 'solidus', github: 'solidusio/solidus', branch: branch
-gem 'solidus_i18n', github: 'solidusio-contrib/solidus_i18n', branch: 'master'
-
-if branch == 'master' || branch >= 'v2.3'
-  gem 'rails', '~> 5.1.0'
-elsif branch >= 'v2.0'
-  gem 'rails', '~> 5.0.0'
-  gem 'rails-controller-testing', group: :test
+
+solidus_git, solidus_frontend_git = if (branch == 'master') || (branch >= 'v3.2')
+                                      %w[solidusio/solidus solidusio/solidus_frontend]
+                                    else
+                                      %w[solidusio/solidus] * 2
+                                    end
+
+gem 'solidus', github: solidus_git, branch: branch
+gem 'solidus_api', github: solidus_git, branch: branch
+gem 'solidus_backend', github: solidus_git, branch: branch
+gem 'solidus_core', github: solidus_git, branch: branch
+gem 'solidus_frontend', github: solidus_frontend_git, branch: branch
+gem 'solidus_sample', github: solidus_git, branch: branch
+
+# Needed to help Bundler figure out how to resolve dependencies,
+# otherwise it takes forever to resolve them.
+# See https://github.com/bundler/bundler/issues/6677
+gem 'rails', ENV.fetch('RAILS_VERSION', nil)
+
+# Provides basic authentication functionality for testing parts of your engine
+gem 'solidus_auth_devise'
+
+case ENV.fetch('DB', nil)
+when 'mysql'
+  gem 'mysql2'
+when 'postgresql'
+  gem 'pg'
 else
-  gem 'rails', '~> 4.2.0'
-  gem 'rails_test_params_backport', group: :test
+  gem 'sqlite3'
 end
 
-gem 'pg', '~> 0.21'
-gem 'sqlite3'
-gem 'mysql2'
+group :test do
+  gem 'rails-controller-testing'
+  gem 'rspec-activemodel-mocks'
+end
 
 group :development, :test do
-  gem 'i18n-tasks', '~> 0.9' if branch == 'master'
+  gem 'factory_bot', '> 4.10.0'
+  gem 'pry-rails'
 end
 
 gemspec
+
+# Use a local Gemfile to include development dependencies that might not be
+# relevant for the project or for other contributors, e.g.: `gem 'pry-debug'`.
+eval_gemfile 'Gemfile-local' if File.exist? 'Gemfile-local'

data/README.md

@@ -1,5 +1,6 @@
-# Solidus Newsletter
-[![Build Status](https://travis-ci.org/jtapia/solidus_newsletter.svg?branch=master)](https://travis-ci.org/jtapia/solidus_newsletter)<br />
+SolidusNewsletter
+=================
+[![CircleCI](https://circleci.com/gh/jtapia/solidus_newsletter.svg?style=shield)](https://circleci.com/gh/jtapia/solidus_newsletter)
 
 Basic Overview
 -----
@@ -26,4 +27,4 @@ Using the newsletter form
 
 ```ruby
 <%= render partial: 'spree/shared/newsletter' %>
-```
+```

data/Rakefile

@@ -1,21 +1,6 @@
-require 'bundler'
-Bundler::GemHelper.install_tasks
+# frozen_string_literal: true
 
-require 'rspec/core/rake_task'
-require 'spree/testing_support/extension_rake'
+require 'solidus_dev_support/rake_tasks'
+SolidusDevSupport::RakeTasks.install
 
-RSpec::Core::RakeTask.new
-
-task :default do
-  if Dir["spec/dummy"].empty?
-    Rake::Task[:test_app].invoke
-    Dir.chdir("../../")
-  end
-  Rake::Task[:spec].invoke
-end
-
-desc 'Generates a dummy app for testing'
-task :test_app do
-  ENV['LIB_NAME'] = 'solidus_newsletter'
-  Rake::Task['extension:test_app'].invoke
-end
+task default: 'extension:specs'

data/app/controllers/spree/admin/newsletters_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Spree
   module Admin
     class NewslettersController < Spree::Admin::BaseController
@@ -7,9 +9,9 @@ module Spree
 
         if (title == newsletter_params[:title] && text == newsletter_params[:text]) &&
             (newsletter_params[:title].present? && newsletter_params[:text])
-          flash[:success] = Spree.t(:'newsletter.admin.success')
+          flash[:success] = I18n.t('spree.newsletter.admin.success')
         else
-          flash[:error] = Spree.t(:'newsletter.admin.error')
+          flash[:error] = I18n.t('spree.newsletter.admin.error')
         end
 
         redirect_to admin_newsletters_edit_path
@@ -30,4 +32,4 @@ module Spree
       end
     end
   end
-end
+end

data/app/controllers/spree/newsletters_controller.rb

@@ -1,15 +1,21 @@
+# frozen_string_literal: true
+
 module Spree
   class NewslettersController < StoreController
     def create
-      @newsletter = Spree::Newsletter.new(newsletter_params)
+      @newsletter = Spree::Newsletter.find_or_initialize_by(newsletter_params)
 
-      if @newsletter.save
-        flash[:success] = Spree.t(:'newsletter.controller.success')
+      if @newsletter.persisted?
+        flash[:notice] = I18n.t('spree.newsletter.controller.already_subscribed')
       else
-        flash[:error] = Spree.t(:'newsletter.controller.error')
+        if @newsletter.save
+          flash[:success] = I18n.t('spree.newsletter.controller.success')
+        else
+          flash[:error] = I18n.t('spree.newsletter.controller.error')
+        end
       end
 
-      redirect_to admin_newsletters_edit_path
+      redirect_to root_path
     end
 
     private
@@ -18,4 +24,4 @@ module Spree
       params.require(:newsletters).permit(:name, :email)
     end
   end
-end
+end

data/app/models/spree/newsletter.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module Spree
   class Newsletter < Spree::Base
     validates :name, presence: true
     validates :email, presence: true, uniqueness: true
   end
-end
+end

data/app/overrides/spree/admin/configurations/index/add_newsletter_to_admin_configurations_menu.html.erb.deface

@@ -1,6 +1,6 @@
 <!-- insert_bottom "[data-hook='admin_configurations_menu']" -->
 
 <tr>
-  <td><%= link_to Spree.t('newsletter.config_name'), admin_newsletters_edit_path %></td>
-  <td><%= Spree.t('newsletter.config_description') %></td>
-</tr>
+  <td><%= link_to I18n.t('spree.newsletter.config_name'), admin_newsletters_edit_path %></td>
+  <td><%= I18n.t('spree.newsletter.config_description') %></td>
+</tr>

data/app/overrides/spree/admin/shared/_configuration_menu/add_newsletter_to_admin_configurations_sidebar_menu.html.erb.deface

@@ -1,3 +1,3 @@
 <!-- insert_bottom "[data-hook='admin_configurations_sidebar_menu']" -->
 
-<%= settings_tab_item Spree.t('newsletter.config_name'), admin_newsletters_edit_path %>
+<%= settings_tab_item I18n.t('spree.newsletter.config_name'), admin_newsletters_edit_path %>

data/app/views/spree/admin/newsletters/_form.html.erb

@@ -3,7 +3,7 @@
     <fieldset class='no-border-bottom'>
      <div class='field'>
         <%= f.field_container :title do %>
-          <%= f.label Spree.t(:'newsletter.title') %>
+          <%= f.label I18n.t('spree.newsletter.title') %>
           <%= f.text_field :title, class: 'fullwidth', value: SolidusNewsletter::Config[:title] %>
           <%= f.error_message_on :title %>
         <% end %>
@@ -11,7 +11,7 @@
 
       <div class='field'>
         <%= f.field_container :text do %>
-          <%= f.label Spree.t(:'newsletter.form.text') %>
+          <%= f.label I18n.t('spree.newsletter.form.text') %>
           <%= f.text_field :text, class: 'fullwidth', value: SolidusNewsletter::Config[:text] %>
           <%= f.error_message_on :text %>
         <% end %>
@@ -24,7 +24,7 @@
       <fieldset class='currency no-border-bottom'>
         <div class='field'>
           <%= f.field_container :title do %>
-            <%= f.label Spree.t(:'newsletter.form.title')  %>
+            <%= f.label I18n.t('spree.newsletter.form.title')  %>
             <%= f.text_field :title, class: 'fullwidth', value: SolidusNewsletter::Config[:title] %>
             <%= f.error_message_on :title %>
           <% end %>
@@ -36,7 +36,7 @@
       <fieldset class='currency no-border-bottom'>
         <div class='field'>
           <%= f.field_container :text do %>
-            <%= f.label Spree.t(:'newsletter.form.text') %>
+            <%= f.label I18n.t('spree.newsletter.form.text') %>
             <%= f.text_field :text, class: 'fullwidth', value: SolidusNewsletter::Config[:text] %>
             <%= f.error_message_on :text %>
           <% end %>

data/app/views/spree/admin/newsletters/edit.html.erb

@@ -1,11 +1,17 @@
 <%= render 'spree/admin/shared/general_tabs' %>
 
-<% admin_breadcrumb(link_to(Spree.t(:'newsletter.admin_breadcrumb'), edit_admin_general_settings_path)) %>
+<% admin_breadcrumb(
+  link_to(
+    I18n.t('spree.newsletter.admin_breadcrumb'),
+    edit_admin_general_settings_path
+  )
+) %>
 
 <%= form_for :newsletters, url: admin_newsletters_update_path, method: :put do |f| %>
   <fieldset class='no-border-top'>
     <%= render 'form', f: f %>
-    <%= render 'spree/admin/shared/edit_resource_links', collection_url: edit_admin_general_settings_url %>
+    <%= render 'spree/admin/shared/edit_resource_links',
+               collection_url: edit_admin_general_settings_url %>
   </fieldset>
 <% end %>
 

data/app/views/spree/shared/_newsletter.html.erb

@@ -1,23 +1,30 @@
 <section class='newsletter-section'>
-  <h2 class='newsletter-section__title'><%= SolidusNewsletter::Config[:title] %></h2>
+  <h2 class='newsletter-section__title'>
+    <%= SolidusNewsletter::Config[:title].html_safe %>
+  </h2>
 
   <div class='newsletter-section__content row'>
-    <%= form_for :newsletter, url: newsletters_update_path, method: :post do |f| %>
+    <%= form_for :newsletters, url: newsletters_path, method: :post do |f| %>
       <div class='field text col-md-3 col-sm-12 text-center'>
-        <p><%= SolidusNewsletter::Config[:text] %></p>
+        <p><%= SolidusNewsletter::Config[:text].html_safe %></p>
       </div>
 
       <div class='field col-md-3 col-sm-6' id=<%= 'name' %>>
-        <%= f.text_field :name, class: 'required fullwidth', autofocus: true, placeholder: Spree.t(:'newsletter.form.name') %>
+        <%= f.text_field :name,
+                         class: 'required fullwidth',
+                         placeholder: I18n.t('spree.newsletter.form.name') %>
       </div>
 
       <div class='field col-md-3 col-sm-6' id=<%= 'email' %>>
-        <%= f.email_field :email, class: 'required fullwidth', placeholder: Spree.t(:'newsletter.form.email') %>
+        <%= f.email_field :email,
+                          class: 'required fullwidth',
+                          placeholder: I18n.t('spree.newsletter.form.email') %>
       </div>
 
       <div class='col-md-3  col-sm-6 form-buttons'>
-        <%= f.submit Spree.t(:'newsletter.form.button'), class: 'newsletter-btn border-rounded small-text' %>
+        <%= f.submit I18n.t('spree.newsletter.form.button'),
+                     class: 'newsletter-btn border-rounded small-text' %>
       </div>
     <% end %>
   </div>
-</section>
+</section>

data/config/locales/en.yml

@@ -13,8 +13,9 @@ en:
   spree:
     newsletter:
       controller:
-        sucess: Thank you to subscribe to our newsletter
+        success: Thank you to subscribe to our newsletter
         error: Something went wrong, please try again
+        already_subscribed: You're already registered
       admin:
         success: The newsletter was updated successfuly!
         error: Something went wrong, please try again

data/config/locales/es-MX.yml

@@ -1,9 +1,10 @@
 es-MX:
   activerecord:
     attributes:
-      name: Nombre
-      email: Email
-      text: Texto
+      spree/newsletter:
+        name: Nombre
+        email: Email
+        text: Texto
     models:
       spree/newsletter:
         one: Newsletter
@@ -12,8 +13,9 @@ es-MX:
   spree:
     newsletter:
       controller:
-        sucess: Gracias por suscribirte a nuestro newsletter
-        error: Hubo un problem, por favor intenta otra vez
+        success: Gracias por suscribirte a nuestro newsletter
+        error: Hubo un problema, por favor intenta otra vez
+        already_subscribed: Ya estas actualmente registrado
       admin:
         success: El texto del newsletter a sido actualizado correctamente
         error: El texto del newsletter no se a podido actualizar, intente más tarde
@@ -21,7 +23,7 @@ es-MX:
         title: Titulo
         text: Texto
         name: Nombre
-        email: Correo Electronico
+        email: Correo Electrónico
         button: Enviar
       admin_breadcrumb: Newsletter
       config_name: Newsletter

data/config/routes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Spree::Core::Engine.routes.draw do
   namespace :admin do
     get '/newsletters/edit' => 'newsletters#edit'

data/db/migrate/20180209175720_add_spree_newsletters_table.rb

@@ -4,7 +4,7 @@ class AddSpreeNewslettersTable < SolidusSupport::Migration[4.2]
       t.string :name
       t.string :email
 
-      t.timestamps
+      t.timestamps null: false
     end
   end
 end

data/lib/solidus_newsletter/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SolidusNewsletter
   class Configuration < Spree::Preferences::Configuration
     preference :title, :string, default: ''

data/lib/solidus_newsletter/engine.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module SolidusNewsletter
   class Engine < Rails::Engine
-    require 'spree/core'
-    isolate_namespace Spree
-    engine_name 'solidus_newsletter'
+    include SolidusSupport::EngineExtensions
 
-    config.autoload_paths += %W(#{config.root}/lib)
+    isolate_namespace ::Spree
+
+    engine_name 'solidus_newsletter'
 
     # use rspec for tests
     config.generators do |g|
@@ -15,12 +17,12 @@ module SolidusNewsletter
       SolidusNewsletter::Config = SolidusNewsletter::Configuration.new
     end
 
-    def self.activate
-      Dir.glob(File.join(File.dirname(__FILE__), "../../app/**/*_decorator*.rb")) do |c|
-        Rails.configuration.cache_classes ? require(c) : load(c)
-      end
-    end
+    # def self.activate
+    #   Dir.glob(File.join(File.dirname(__FILE__), "../../app/**/*_decorator*.rb")) do |c|
+    #     Rails.configuration.cache_classes ? require(c) : load(c)
+    #   end
+    # end
 
-    config.to_prepare &method(:activate).to_proc
+    # config.to_prepare &method(:activate).to_proc
   end
 end

data/lib/solidus_newsletter/testing_support/factories.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :newsletter, class: Spree::Newsletter do
+    name { 'User Test' }
+    email { 'user@test.com' }
+  end
+end

data/lib/solidus_newsletter/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SolidusNewsletter
-  VERSION = '1.0'
+  VERSION = '1.1'
 end

data/lib/solidus_newsletter.rb

@@ -1,2 +1,10 @@
+# frozen_string_literal: true
+
 require 'solidus_core'
+require 'solidus_backend'
+require 'solidus_support'
+require 'deface'
+
+require 'solidus_newsletter/version'
+require 'solidus_newsletter/configuration'
 require 'solidus_newsletter/engine'

data/solidus_newsletter.gemspec

@@ -1,10 +1,7 @@
-# encoding: UTF-8
-$:.push File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
 
-# Maintain your gem's version:
-require 'solidus_newsletter/version'
+require_relative 'lib/solidus_newsletter/version'
 
-# Describe your gem and declare its dependencies:
 Gem::Specification.new do |s|
   s.name        = 'solidus_newsletter'
   s.version     = SolidusNewsletter::VERSION
@@ -14,24 +11,29 @@ Gem::Specification.new do |s|
   s.summary     = 'Solidus Newsletter extension'
   s.description = 'Adds a newsletter form to the homepage'
 
-  # s.files = Dir['{app,config,models,db,lib}/**/*'] + %w(MIT-LICENSE Rakefile README.md)
   s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- spec/*`.split("\n")
   s.require_path  = 'lib'
   s.requirements << 'none'
 
-  solidus_version = ['>= 1.2', '< 3']
+  if s.respond_to?(:metadata)
+    s.metadata['homepage_uri'] = s.homepage
+    s.metadata['source_code_uri'] = 'https://github.com/jtapia/solidus_newsletter'
+    s.metadata['rubygems_mfa_required'] = 'true'
+  end
+
+  s.required_ruby_version = Gem::Requirement.new('>= 2.5')
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  files = Dir.chdir(__dir__) { `git ls-files -z`.split("\x0") }
+
+  solidus_version = ['>= 2.5', '< 4']
+
   s.add_dependency 'solidus_core', solidus_version
-  s.add_dependency 'solidus_backend', solidus_version
-  s.add_dependency 'solidus_api', solidus_version
-  s.add_dependency 'solidus_support'
-
-  s.add_development_dependency 'database_cleaner', '~> 1.6'
-  s.add_development_dependency 'factory_bot', '~> 4.4'
-  s.add_development_dependency 'ffaker'
-  s.add_development_dependency 'rspec-rails', '~> 3.3'
-  s.add_development_dependency 'simplecov', '~> 0.14'
-  s.add_development_dependency 'rspec-activemodel-mocks'
-  s.add_development_dependency 'webmock'
-  s.add_development_dependency 'byebug'
-end
+  s.add_dependency 'solidus_support', '~> 0.5'
 
+  s.add_development_dependency 'solidus_backend', solidus_version
+  s.add_development_dependency 'solidus_dev_support', '~> 2.5'
+  s.add_development_dependency 'solidus_frontend', solidus_version
+end

data/spec/controllers/spree/admin/newsletters_controller_spec.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
-describe Spree::Admin::NewslettersController, type: :controller do
+RSpec.describe Spree::Admin::NewslettersController, type: :controller do
   stub_authorization!
 
   before do
@@ -24,4 +26,4 @@ describe Spree::Admin::NewslettersController, type: :controller do
       expect(flash[:error]).to include('Something went wrong, please try again')
     end
   end
-end
+end

data/spec/controllers/spree/newsletters_controller_spec.rb

@@ -1,19 +1,50 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
-describe Spree::NewslettersController, type: :controller do
+RSpec.describe Spree::NewslettersController, type: :controller do
+  let(:newsletter) { create(:newsletter) }
+
   context '#create' do
-    it 'returns true' do
-      post :create, params: { newsletters: { name: 'User Test', email: 'user@test.com' } }
+    it 'returns true new object' do
+      post :create,
+           params: {
+             newsletters: {
+               name: 'User Test',
+               email: 'user@test.com'
+             }
+           }
 
       expect(response.status).to eq(302)
-      expect(flash[:success]).to include(Spree.t('newsletter.controller.success'))
+      expect(flash[:success])
+        .to include(I18n.t('spree.newsletter.controller.success'))
     end
 
     it 'returns false' do
-      post :create, params: { newsletters: { name: '', email: '' } }
+      post :create,
+           params: {
+             newsletters: {
+               name: '',
+               email: ''
+             }
+           }
+
+      expect(response.status).to eq(302)
+      expect(flash[:error]).to include(I18n.t('spree.newsletter.controller.error'))
+    end
+
+    it 'returns already added' do
+      post :create,
+           params: {
+             newsletters: {
+               name: newsletter.name,
+               email: newsletter.email
+             }
+           }
 
       expect(response.status).to eq(302)
-      expect(flash[:error]).to include(Spree.t('newsletter.controller.error'))
+      expect(flash[:notice])
+        .to include(I18n.t('spree.newsletter.controller.already_subscribed'))
     end
   end
-end
+end