koalagator 2.0.0

data/lib/generators/calagator/templates/config/initializers/01_calagator.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+Calagator.setup do |config|
+  # Site name
+  config.title = 'Calagator'
+
+  # Site tagline
+  config.tagline = 'A Tech Calendar'
+
+  # Site URL with trailing slash
+  config.url = 'http://my-calagator.org/'
+
+  # Email address of administrator that will get exception notifications
+  # and requests for assistance from users:
+  config.administrator_email = 'your@email.addr'
+
+  # Optional username and password to use when accessing /admin pages
+  # config.admin_username = 'admin'
+  # config.admin_password = ENV['CALAGATOR_ADMIN_PASSWORD']
+
+  # Search engine to use for searching events.
+  # Values: :sql, :sunspot.
+  config.search_engine = :sql
+
+  # Set the iCalendar SEQUENCE, which should be increased each time an event
+  # is updated. If an admin needs to forcefully increment the SEQUENCE for all
+  # events, they can set this icalendar_sequence_offset value to something
+  # greater than 0.
+  config.icalendar_sequence_offset = 0
+
+  # Configure a mapping provider
+  # Stamen's terrain tiles will be used by default.
+  # Map marker color
+  # Values: red, darkred, orange, green, darkgreen, blue, purple, darkpuple, cadetblue
+  config.mapping_marker_color = 'green'
+
+  # A Google Maps API key is required to use Google's geocoding service
+  # as well as to display maps using their API.
+  # Get one at: https://developers.google.com/maps/documentation/javascript/tutorial#api_key
+  #
+  # This is sensitive information and should not be stored in version control.
+  config.mapping_google_maps_api_key = ENV['GOOGLE_MAPS_API_KEY']
+
+  # The tile provider to use when rendering maps with Leaflet.
+  # One of: leaflet, stamen, mapbox, google
+  config.mapping_provider = 'stamen'
+
+  # The tiles to use for the map, see the docs for individual Leaflet plugins.
+  config.mapping_tiles = 'terrain'
+
+  # Other mapping examples:
+  #
+  # Stamen
+  # (available tiles: terrain, toner, watercolor)
+  # config.mapping_provider = 'stamen'
+  # config.mapping_tiles = 'watercolor'
+  #
+  # MapBox Streets (use a map from your own account)
+  # config.mapping_provider = 'mapbox'
+  # config.mapping_tiles = 'examples.map-9ijuk24y'
+  #
+  # Google Maps
+  # config.mapping_provider = 'google'
+  # config.mapping_tiles = 'ROADMAP'
+  #
+  # OpenStreetMap
+  # config.mapping_provider = 'leaflet'
+  # config.mapping_tiles = 'http://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png'
+  #
+  # Esri
+  # (available tiles: Gray, Streets, Oceans, Topographic)
+  # config.mapping_provider = 'esri'
+  # config.mapping_tiles = 'Gray'
+
+  # Map to display on /venues page:
+  config.venues_map_options = {
+    # Zoom magnification level:
+    zoom: 12
+
+    # Center of the map, in latitude and longitude.
+    # If no center is specified, the map will zoom to fit all markers.
+    # center: [45.518493, -122.660737]
+  }
+
+  # Patterns for detecting spam events and venues
+  config.denylist_patterns = [
+    /\b(online|overseas).+(drugstore|pharmacy)\b/,
+    /\bcialis\b/
+  ]
+end

data/lib/generators/calagator/templates/config/initializers/02_geokit.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+# Edit this file to configure Geokit, which Calagator uses to geocode venues.
+# Geocoding lets us find the latitude/longitude of an entered address.
+
+require 'geokit'
+
+# This is the order in which the geocoders are called in a failover scenario
+# If you only want to use a single geocoder, put a single symbol in the array.
+#
+# Be aware that there are Terms of Use restrictions on how you can use the
+# various geocoders.  Make sure you read up on relevant Terms of Use for each
+# geocoder you are going to use.
+
+Geokit::Geocoders.provider_order = [:google]
+
+# These defaults are used in Geokit::Mappable.distance_to and in acts_as_mappable
+Geokit.default_units = :miles
+Geokit.default_formula = :sphere
+
+# This is your Google Maps geocoder keys (all optional).
+# See http://www.google.com/apis/maps/signup.html
+# and http://www.google.com/apis/maps/documentation/#Geocoding_Examples
+#
+# Geokit::Geocoders::GoogleGeocoder.client_id = ''
+# Geokit::Geocoders::GoogleGeocoder.cryptographic_key = ''
+# Geokit::Geocoders::GoogleGeocoder.channel = ''
+
+# You can also use the free API key instead of signed requests
+# See https://developers.google.com/maps/documentation/geocoding/#api_key
+# Geokit::Geocoders::GoogleGeocoder.api_key = ''
+#
+# CALAGATOR:
+# We populate this with the API key set for Google Maps in 01_calagator.rb by default
+Geokit::Geocoders::GoogleGeocoder.api_key = Calagator.mapping_google_maps_api_key
+
+# You can also set multiple API KEYS for different domains that may be directed to this same application.
+# The domain from which the current user is being directed will automatically be updated for Geokit via
+# the GeocoderControl class, which gets it's begin filter mixed into the ActionController.
+# You define these keys with a Hash as follows:
+#
+# Geokit::Geocoders::google = { 'rubyonrails.org' => 'RUBY_ON_RAILS_API_KEY', 'ruby-docs.org' => 'RUBY_DOCS_API_KEY' }
+
+# This is your yahoo application key for the Yahoo Geocoder.
+# See http://developer.yahoo.com/faq/index.html#appid
+# and http://developer.yahoo.com/maps/rest/V1/geocode.html
+#
+# Geokit::Geocoders::YahooGeocoder.key = 'REPLACE_WITH_YOUR_YAHOO_KEY'
+# Geokit::Geocoders::YahooGeocoder.secret = 'REPLACE_WITH_YOUR_YAHOO_SECRET'
+
+# This is your username and password for geocoder.us.
+# To use the free service, the value can be set to nil or false.  For
+# usage tied to an account, the value should be set to username:password.
+# See http://geocoder.us
+# and http://geocoder.us/user/signup
+#
+# Geokit::Geocoders::UsGeocoder.key = 'username:password'
+
+# This is your authorization key for geocoder.ca.
+# To use the free service, the value can be set to nil or false.  For
+# usage tied to an account, set the value to the key obtained from
+# Geocoder.ca.
+# See http://geocoder.ca
+# and http://geocoder.ca/?register=1
+#
+# Geokit::Geocoders::CaGeocoder.key = 'KEY'
+
+# This is your username key for geonames.
+# To use this service either free or premium, you must register a key.
+# See http://www.geonames.org
+#
+# Geokit::Geocoders::GeonamesGeocoder.key = 'KEY'
+
+# Most other geocoders need either no setup or a key
+# Geokit::Geocoders::BingGeocoder.key = ''
+# Geokit::Geocoders::MapQuestGeocoder.key = ''
+# Geokit::Geocoders::YandexGeocoder.key = ''
+# Geokit::Geocoders::MapboxGeocoder.key = 'ACCESS_TOKEN'
+# Geokit::Geocoders::OpencageGeocoder.key = 'some_api_key'
+
+# Geonames has a free service and a premium service, each using a different URL
+# GeonamesGeocoder.premium = true will use http://ws.geonames.net (premium)
+# GeonamesGeocoder.premium = false will use http://api.geonames.org (free)
+# Geokit::Geocoders::GeonamesGeocoder.premium = false
+
+# The IP provider order. Valid symbols are :ip,:geo_plugin.
+# As before, make sure you read up on relevant Terms of Use for each.
+# Geokit::Geocoders::ip_provider_order = [:external,:geo_plugin,:ip]
+
+# Disable HTTPS globally.  This option can also be set on individual
+# geocoder classes.
+# Geokit::Geocoders::secure = false
+
+# Control verification of the server certificate for geocoders using HTTPS
+# Geokit::Geocoders::ssl_verify_mode = OpenSSL::SSL::VERIFY_(PEER/NONE)
+#
+# Setting this to VERIFY_NONE may be needed on systems that don't have
+# a complete or up to date root certificate store. Only applies to
+# the Net::HTTP adapter.
+
+# This is the timeout value in seconds to be used for calls to the geocoder web
+# services.  For no timeout at all, comment out the setting.  The timeout unit
+# is in seconds.
+Geokit::Geocoders.request_timeout = 3
+
+# This setting can be used if web service calls must be routed through a proxy.
+# These setting can be nil if not needed, otherwise, a valid URI must be
+# filled in at a minimum.  If the proxy requires authentication, the username
+# and password can be provided as well.
+#
+# Geokit::Geocoders::proxy = 'https://user:password@host:port'

data/lib/generators/calagator/templates/config/initializers/03_recaptcha.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'recaptcha/rails'
+
+Recaptcha.configure do |config|
+  config.site_key = ENV['RECAPTCHA_SITE_KEY']
+  config.secret_key = ENV['RECAPTCHA_SECRET_KEY']
+  # Uncomment the following line if you are using a proxy server:
+  # config.proxy = 'http://myproxy.com.au:8080'
+end

data/lib/tasks/auto_annotate_models.rake

@@ -0,0 +1,59 @@
+# NOTE: only doing this in development as some production environments (Heroku)
+# NOTE: are sensitive to local FS writes, and besides -- it's just not proper
+# NOTE: to have a dev-mode tool do its thing in production.
+if Rails.env.development?
+  require 'annotate'
+  task :set_annotation_options do
+    # You can override any of these by setting an environment variable of the
+    # same name.
+    Annotate.set_defaults(
+      'active_admin'                => 'false',
+      'additional_file_patterns'    => [],
+      'routes'                      => 'false',
+      'models'                      => 'true',
+      'position_in_routes'          => 'before',
+      'position_in_class'           => 'before',
+      'position_in_test'            => 'before',
+      'position_in_fixture'         => 'before',
+      'position_in_factory'         => 'before',
+      'position_in_serializer'      => 'before',
+      'show_foreign_keys'           => 'true',
+      'show_complete_foreign_keys'  => 'false',
+      'show_indexes'                => 'true',
+      'simple_indexes'              => 'false',
+      'model_dir'                   => 'app/models',
+      'root_dir'                    => '',
+      'include_version'             => 'false',
+      'require'                     => '',
+      'exclude_tests'               => 'false',
+      'exclude_fixtures'            => 'false',
+      'exclude_factories'           => 'false',
+      'exclude_serializers'         => 'false',
+      'exclude_scaffolds'           => 'true',
+      'exclude_controllers'         => 'true',
+      'exclude_helpers'             => 'true',
+      'exclude_sti_subclasses'      => 'false',
+      'ignore_model_sub_dir'        => 'false',
+      'ignore_columns'              => nil,
+      'ignore_routes'               => nil,
+      'ignore_unknown_models'       => 'false',
+      'hide_limit_column_types'     => 'integer,bigint,boolean',
+      'hide_default_column_types'   => 'json,jsonb,hstore',
+      'skip_on_db_migrate'          => 'false',
+      'format_bare'                 => 'true',
+      'format_rdoc'                 => 'false',
+      'format_yard'                 => 'false',
+      'format_markdown'             => 'false',
+      'sort'                        => 'false',
+      'force'                       => 'false',
+      'frozen'                      => 'false',
+      'classified_sort'             => 'true',
+      'trace'                       => 'false',
+      'wrapper_open'                => nil,
+      'wrapper_close'               => nil,
+      'with_comment'                => 'true'
+    )
+  end
+
+  Annotate.load_tasks
+end

data/lib/tasks/spec_db.rake

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+namespace :spec do
+  namespace :db do
+    databases = %i[postgresql mysql sqlite3]
+
+    desc 'Run specs against all databases'
+    task :all do
+      failed = false
+
+      databases.each do |database|
+        test_against database
+      end
+    end
+
+    databases.each do |database|
+      desc "Run specs against '#{database}' database"
+      task database do
+        return test_against database
+      end
+    end
+
+    def test_against(kind)
+      sample = Rails.root + "config/database~#{kind}.sample.yml"
+      custom = Rails.root + 'config/database~custom.yml'
+      backup = Rails.root + 'config/database~custom.yml.backup'
+
+      mv custom, backup if custom.exist?
+
+      cp sample, custom
+
+      succeeded = nil
+
+      begin
+        Dir.chdir(Rails.root) do
+          puts
+          puts "## Database: #{kind}"
+          succeeded = system 'unset BUNDLE_GEMFILE BUNDLE_BIN_PATH RUBYOPT; bundle --quiet && rake db:create:all db:migrate db:test:prepare spec'
+        end
+      ensure
+        rm custom
+
+        mv backup, custom if backup.exist?
+      end
+
+      raise "Tests failed against database '#{kind}'" unless succeeded
+    end
+  end
+end

data/lib/tasks/sunspot_reindex_calagator.rake

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+desc 'Reindex Calagator models with Sunspot'
+task 'sunspot:reindex:calagator' do
+  # Silence warnings about already-initialized constants caused by
+  # sunspot-rails' aggressive eager loading of all engine files.
+  original_verbosity = $VERBOSE
+  $VERBOSE = nil
+
+  puts 'Reindexing Venues…'
+  Rake.application['sunspot:solr:reindex'].invoke(500, 'Calagator::Venue')
+
+  Rake.application['sunspot:solr:reindex'].reenable
+  Rake.application['sunspot:reindex'].reenable
+
+  puts 'Reindexing Events…'
+  Rake.application['sunspot:solr:reindex'].invoke(500, 'Calagator::Event')
+
+  $VERBOSE = original_verbosity
+end

data/lib/tasks/sunspot_solr_restart_enhancements.rake

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'wait_for_solr'
+
+task 'sunspot:solr:start_with_waiting' => :environment do
+  port = Sunspot::Rails.configuration.port
+
+  next puts 'Solr already running' if WaitForSolr.running_on?(port)
+
+  puts 'Starting Solr ...'
+
+  # is namespaced within app when invoked from the engine repo
+  task = Rake::Task.task_defined?('app:sunspot:solr:start') ? 'app:sunspot:solr:start' : 'sunspot:solr:start'
+  Rake.application.invoke_task(task)
+
+  print 'Waiting for Solr '
+  WaitForSolr.on(port, 30) { print '.' }
+
+  puts ' done'
+end

data/lib/tasks/update_counter_caches.rake

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+desc 'Update counter caches'
+task update_counter_caches: :environment do
+  # Update the Venue#events_count
+  total = Calagator::Venue.count
+  Calagator::Venue.all.each do |venue|
+    cached = venue.events_count
+    actual = venue.events.count
+    if actual != cached
+      puts "Updating Venue ##{venue.id} from #{cached} cached to #{actual} actual -- #{venue.title}"
+      Calagator::Venue.connection.update("UPDATE venues SET events_count = #{actual} WHERE id = #{venue.id}")
+    end
+  end
+end

data/lib/templates/erb/scaffold/_form.html.erb

@@ -0,0 +1,11 @@
+<%%= semantic_form_for @<%= singular_name %> do |f| %>
+  <%%= f.inputs do %>
+  <%- attributes.each do |attribute| -%>
+    <%%= f.input :<%= attribute.name %> %>
+  <%- end -%>
+  <%% end %>
+
+  <%%= f.buttons do %>
+    <%%= f.commit_button %>
+  <%% end %>
+<%% end %>

data/lib/theme_reader.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# = ThemeReader
+#
+# Returns name of the theme to use.
+
+class ThemeReader
+  def self.read
+    rails_root = begin
+                   Rails.root
+                 rescue StandardError
+                   File.dirname(File.dirname(__FILE__))
+                 end
+    theme_txt = "#{rails_root}/config/theme.txt"
+    if ENV['THEME']
+      ENV['THEME']
+    elsif File.exist?(theme_txt)
+      File.read(theme_txt).strip
+    else
+      'default'
+    end
+  end
+end

data/lib/wait_for_solr.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'timeout'
+
+class WaitForSolr < Struct.new(:port, :timeout)
+  def self.on(port, timeout, &block)
+    new(port, timeout).wait &block
+  end
+
+  def self.running_on?(port)
+    new(port).responding?
+  end
+
+  def wait
+    Timeout.timeout timeout do
+      until responding?
+        yield
+        sleep 1
+      end
+    end
+  end
+
+  def responding?
+    system %(curl -o /dev/null "http://localhost:#{port}/solr" > /dev/null 2>&1)
+  end
+end

data/rails_template.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'rubygems'
+require 'pathname'
+
+RAILS_REQUIREMENT = '~> 5.2'
+
+def assert_minimum_rails_version
+  requirement = Gem::Requirement.new(RAILS_REQUIREMENT)
+  rails_version = Gem::Version.new(Rails::VERSION::STRING)
+  return if requirement.satisfied_by?(rails_version)
+
+  puts "Calagator requires Rails #{RAILS_REQUIREMENT}. You are using #{rails_version}."
+  exit 1
+end
+
+assert_minimum_rails_version
+
+generating_test_app = ARGV.include? '--test_app'
+calagator_checkout = Pathname.new(File.expand_path(__dir__))
+relative_calagator_path = calagator_checkout.relative_path_from(Pathname.new(destination_root))
+
+if options[:database] == 'postgresql' && ARGV.any? { |arg| arg =~ /--postgres-username=(\w+)/ }
+  inside('config') do
+    run "sed -e 's/username: .*/username: #{Regexp.last_match(1)}/' -i -- database.yml"
+  end
+end
+
+# FactoryBot and Faker are required for Calagator's db:seed task
+spec = Gem::Specification.load(File.expand_path('calagator.gemspec', __dir__))
+spec ||= Gem::Specification.find_by_name('calagator')
+required_dev_gems = %w[factory_bot_rails faker]
+
+gem_group :development, :test do
+  if spec
+    spec_dependencies = spec.development_dependencies.select { |dep| required_dev_gems.include?(dep.name) }
+    spec_dependencies.each do |dep|
+      gem(+dep.name, dep.requirement.to_s)
+    end
+  else
+    required_dev_gems.each { |gem_name| gem gem_name }
+  end
+end
+
+gem 'calagator', (generating_test_app && { path: relative_calagator_path.to_s })
+run 'bundle install'
+rake 'db:create'
+inside('app/assets') do
+  create_file('config/manifest.js') do
+    <<-MANIFEST.strip_heredoc
+      //= link application.js
+      //= link application.css
+      //= link calagator/manifest.js
+    MANIFEST
+  end
+end
+generate 'calagator:install', (generating_test_app && '--test_app')
+generate 'sunspot_rails:install'

data/spec/controllers/calagator/application_controller_spec.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+module Calagator
+  describe ApplicationController, type: :controller do
+    describe '#append_flash' do
+      before do
+        flash.clear
+      end
+
+      it "sets flash message if one isn't set already" do
+        controller.send(:append_flash, :failure, 'Hello.')
+        expect(flash[:failure]).to eq 'Hello.'
+      end
+
+      it 'appends flash message if one is already set' do
+        controller.send(:append_flash, :failure, 'Hello.')
+        controller.send(:append_flash, :failure, 'World.')
+        expect(flash[:failure]).to eq 'Hello. World.'
+      end
+    end
+
+    describe '#help' do
+      it 'responds to a view helper method' do
+        expect(controller.send(:help)).to respond_to :link_to
+      end
+
+      it 'does not respond to an invalid method' do
+        expect(controller.send(:help)).not_to respond_to :no_such_method
+      end
+    end
+
+    describe '#escape_once' do
+      let(:raw) { 'this & that' }
+      let(:escaped) { 'this & that' }
+
+      it 'escapes raw string' do
+        expect(controller.send(:escape_once, raw)).to eq escaped
+      end
+
+      it 'does not escape an already escaped string' do
+        expect(controller.send(:escape_once, escaped)).to eq escaped
+      end
+    end
+
+    describe '#recaptcha_enabled?' do
+      subject do
+        result = nil
+
+        Recaptcha.with_configuration(site_key: temporary_key) do
+          result = controller.send(:recaptcha_enabled?)
+        end
+
+        result
+      end
+
+      let(:temporary_key) { nil }
+
+      context 'when Recaptcha site_key is not set' do
+        it { is_expected.to be_falsey }
+      end
+
+      context 'when ENV key is set' do
+        let(:temporary_key) { 'asdf' }
+
+        it { is_expected.to be_truthy }
+      end
+    end
+  end
+end