threddedDANIEL 0.14.5

data/lib/thredded/db_tools.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+module Thredded
+  module DbTools
+    class << self
+      MIGRATION_SPEC_SOURCE_VERSION = 'v0.8'
+
+      # Runs the migrations in the given paths.
+      def migrate(paths:, quiet:, &filter)
+        verbose_was = ActiveRecord::Migration.verbose
+        ActiveRecord::Migration.verbose = !quiet
+        migrate = lambda do
+          if Rails::VERSION::STRING >= '5.2'
+            ActiveRecord::MigrationContext.new(paths).migrate(nil, &filter)
+          else
+            ActiveRecord::Migrator.migrate(paths, &filter)
+          end
+        end
+        if quiet
+          silence_active_record(&migrate)
+        else
+          migrate.call
+        end
+      ensure
+        ActiveRecord::Migration.verbose = verbose_was
+      end
+
+      def dump_file
+        File.expand_path("../../../spec/migration/#{MIGRATION_SPEC_SOURCE_VERSION}.#{adapter}.dump", __FILE__)
+      end
+
+      def dump(to = dump_file)
+        case adapter
+        when /sqlite/i
+          system ['sqlite3', Rails.root.join(database), '.dump', '>', to].join(' ')
+        when /postgres/i
+          cmd = "pg_dump --dbname=postgresql://#{username}:#{password}@#{host}:5432/#{database}" \
+            "--verbose --clean --no-owner --no-acl --format=c > #{to}"
+          system cmd
+        when /mysql/i
+          system("mysqldump --user #{username} -p#{password} #{database} > #{to}")
+        end
+      end
+
+      def restore(from = dump_file)
+        case adapter
+        when /postgres/i
+          cmd = [
+            'pg_restore --verbose --clean --no-owner --no-acl',
+            "--dbname=postgresql://#{username}:#{password}@#{host}:5432/#{database}",
+            from,
+            '>',
+            Rails.root.join('log', 'restore.log')
+          ].join(' ')
+          system cmd
+        when /mysql/i, /sqlite/i
+          connection = ActiveRecord::Base.connection
+          statements = File.read(from).split(/;$/)
+          statements.pop
+          silence_active_record do
+            ActiveRecord::Base.transaction do
+              statements.each do |statement|
+                connection.execute(statement) unless statement =~ /(BEGIN TRANSACTION|COMMIT)/
+              end
+            end
+          end
+        end
+      end
+
+      def silence_active_record
+        was = ActiveRecord::Base.logger.level
+        ActiveRecord::Base.logger.level = Logger::WARN
+        yield
+      ensure
+        ActiveRecord::Base.logger.level = was
+      end
+
+      def config
+        @config ||= Rails.configuration.database_configuration[Rails.env]
+      end
+
+      def adapter
+        config['adapter']
+      end
+
+      def database
+        config['database']
+      end
+
+      def username
+        config['username']
+      end
+
+      def password
+        config['password']
+      end
+
+      def host
+        config['host']
+      end
+    end
+  end
+end

data/lib/thredded/email_transformer.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'thredded/email_transformer/onebox'
+
+module Thredded
+  # This transformer should applied to emails so that they render correctly in the email clients.
+  #
+  # For example, if you use roadie, you can configure it to use the transformer in the initializer:
+  #
+  #     # config/initializers/roadie.rb
+  #     Rails.application.config.roadie.before_transformation = Thredded::EmailTransformer
+  #
+  module EmailTransformer
+    mattr_accessor :transformers
+    self.transformers = [Onebox]
+
+    # @param doc [Nokogiri::HTML::Document]
+    def self.call(doc)
+      transformers.each { |transformer| transformer.call(doc) }
+    end
+  end
+end

data/lib/thredded/email_transformer/base.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Thredded
+  module EmailTransformer
+    # A helper module with common functions for constructing Nokogiri elements.
+    module Helpers
+      # Creates a `<p>` node with the given child
+      def paragraph(child)
+        Nokogiri::XML::Node.new('p', doc).tap do |p|
+          p.add_child child
+        end
+      end
+
+      # Creates an `<a>` node with the given attributes and content
+      def anchor(href, target: '_blank', content: href)
+        Nokogiri::XML::Node.new('a', doc).tap do |a|
+          a['href'] = href
+          a['target'] = target
+          a.content = content
+        end
+      end
+    end
+
+    class Base
+      include Helpers
+
+      # @return [Nokogiri::HTML::Document]
+      attr_reader :doc
+
+      # @param doc [Nokogiri::HTML::Document]
+      def initialize(doc)
+        @doc = doc
+      end
+
+      def self.inherited(base)
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        # @param doc [Nokogiri::HTML::Document]
+        def call(doc)
+          new(doc).call
+        end
+      end
+    end
+  end
+end

data/lib/thredded/email_transformer/onebox.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'thredded/email_transformer/base'
+module Thredded
+  module EmailTransformer
+    # Wraps oneboxes with tables, because only tables can have borders in most email clients.
+    class Onebox < Base
+      def call
+        doc.css('aside.onebox').each do |onebox|
+          table = Nokogiri::XML::Node.new('table', doc)
+          table['class'] = 'onebox-wrapper-table'
+          onebox.swap table
+          table
+            .add_child(Nokogiri::XML::Node.new('tr', doc))
+            .add_child(Nokogiri::XML::Node.new('td', doc))
+            .add_child(onebox)
+        end
+      end
+    end
+  end
+end

data/lib/thredded/engine.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Thredded
+  class Engine < ::Rails::Engine
+    isolate_namespace Thredded
+
+    config.generators do |g|
+      g.test_framework :rspec, fixture: true
+      g.fixture_replacement :factory_bot, dir: 'spec/factories'
+      g.helper false
+    end
+
+    config.to_prepare do
+      Thredded::AllViewHooks.reset_instance!
+      if Thredded.user_class
+        Thredded.user_class.send(:include, Thredded::UserExtender)
+      end
+    end
+
+    initializer 'thredded.setup_assets' do
+      Thredded::Engine.config.assets.precompile += %w[
+        thredded.js
+        thredded.css
+        thredded/*.svg
+      ]
+    end
+  end
+end

data/lib/thredded/errors.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Thredded
+  class Error < StandardError
+  end
+
+  module Errors
+    class DatabaseEmpty < Thredded::Error
+      def message
+        'Seed the database with "rake db:seed".'
+      end
+    end
+
+    class LoginRequired < Thredded::Error
+      def message
+        I18n.t('thredded.errors.login_required')
+      end
+    end
+
+    class UserNotFound < Thredded::Error
+      def message
+        'This user could not be found. Is their name misspelled?'
+      end
+    end
+
+    class PrivateTopicNotFound < Thredded::Error
+      def message
+        I18n.t('thredded.errors.private_topic_not_found')
+      end
+    end
+
+    class TopicNotFound < Thredded::Error
+      def message
+        'This topic does not exist.'
+      end
+    end
+
+    class MessageboardNotFound < Thredded::Error
+      def message
+        'This messageboard does not exist.'
+      end
+    end
+
+    class MessageboardReadDenied < Thredded::Error
+      def message
+        'You are not authorized access to this messageboard.'
+      end
+    end
+
+    class MessageboardCreateDenied < Thredded::Error
+      def message
+        'You are not authorized to create a new messageboard.'
+      end
+    end
+
+    class TopicCreateDenied < Thredded::Error
+      def message
+        'You are not authorized to post in this messageboard.'
+      end
+    end
+
+    class PrivateTopicCreateDenied < Thredded::Error
+      def message
+        I18n.t('thredded.errors.private_topic_create_denied')
+      end
+    end
+  end
+end

data/lib/thredded/formatting_demo_content.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Thredded
+  # Content for demo-ing formatting functionality
+  module FormattingDemoContent
+    class << self
+      attr_accessor :parts
+    end
+    self.parts = [
+      <<-'MARKDOWN',
+#### Oneboxes
+
+URLs of supported resources are replaced with boxes like these:
+
+**Twitter** `https://twitter.com/thredded/status/838824533477982209`:
+https://twitter.com/thredded/status/838824533477982209
+**StackExchange** `http://codegolf.stackexchange.com/questions/45701`:
+http://codegolf.stackexchange.com/questions/45701
+**Amazon** `https://www.amazon.co.uk/dp/0521797071`:
+https://www.amazon.co.uk/dp/0521797071
+**YouTube** `https://www.youtube.com/watch?v=1QP7elXwpLw`:
+https://www.youtube.com/watch?v=1QP7elXwpLw
+**Google Maps** `https://goo.gl/maps/R6nj3Qwf2LR2`:
+https://goo.gl/maps/R6nj3Qwf2LR2
+
+Many more resources are [supported](https://github.com/discourse/onebox/tree/master/lib/onebox/engine). Powered by the [onebox](https://github.com/discourse/onebox) library.
+      MARKDOWN
+    ]
+  end
+end

data/lib/thredded/html_pipeline/at_mention_filter.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module Thredded
+  module HtmlPipeline
+    class AtMentionFilter < ::HTML::Pipeline::Filter
+      DEFAULT_IGNORED_ANCESTOR_TAGS = %w[pre code tt a style].freeze
+
+      # @param context [Hash]
+      # @option context :users_provider [#call(usernames)] given usernames, returns a list of users.
+      def initialize(doc, context = nil, result = nil)
+        super doc, context, result
+        @users_provider = context[:users_provider]
+        @view_context = context[:view_context]
+      end
+
+      def call
+        return doc unless @users_provider
+        process_text_nodes! do |node|
+          content = node.to_html
+          next unless content.include?('@')
+          highlight! content
+          node.replace content
+        end
+        doc
+      end
+
+      # @return [Array<Thredded.user_class>] users that were @-mentioned
+      def mentioned_users
+        return [] unless @users_provider
+        names = []
+        process_text_nodes! { |node| names.concat mentioned_names(node.to_html) }
+        names.uniq!
+        @users_provider.call(names)
+      end
+
+      private
+
+      MATCH_NAME_RE = /(?:^|[\s>])@([\w\-]+|"[\w.,\- ()]+")(?=\W|$)/
+
+      def mentioned_names(text_node_html)
+        text_node_html.scan(MATCH_NAME_RE).map(&:first).map { |m| m.start_with?('"') ? m[1..-2] : m }
+      end
+
+      def highlight!(text_node_html)
+        names = mentioned_names(text_node_html)
+        return if names.blank?
+        @users_provider.call(names).each do |user|
+          name = user.thredded_display_name
+          maybe_quoted_name = name =~ /[., ()]/ ? %("#{name}") : name
+          url = Thredded.user_path(@view_context, user)
+          text_node_html.gsub!(
+            /(^|[\s>])(@#{Regexp.escape maybe_quoted_name})([^a-z\d]|$)/i,
+            %(\\1<a href="#{ERB::Util.html_escape url}">@#{ERB::Util.html_escape maybe_quoted_name}</a>\\3)
+          )
+        end
+      end
+
+      # Yields text nodes that should be processed.
+      def process_text_nodes!
+        doc.search('.//text()').each do |node|
+          next if has_ancestor?(node, ignored_ancestor_tags)
+          yield node
+        end
+      end
+
+      # Return ancestor tags to stop the at-mention highlighting.
+      #
+      # @return [Array<String>] Ancestor tags.
+      def ignored_ancestor_tags
+        if @context[:ignored_ancestor_tags]
+          DEFAULT_IGNORED_ANCESTOR_TAGS | @context[:ignored_ancestor_tags]
+        else
+          DEFAULT_IGNORED_ANCESTOR_TAGS
+        end
+      end
+    end
+  end
+end

data/lib/thredded/html_pipeline/autolink_filter.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Thredded
+  module HtmlPipeline
+    # HTML Filter for auto_linking urls in HTML.
+    #
+    # AutolinkFilter is required because Kramdown does not autolink by default.
+    # https://github.com/gettalong/kramdown/issues/306
+    class AutolinkFilter < ::HTML::Pipeline::Filter
+      def call
+        Rinku.auto_link(html, :all)
+      end
+    end
+  end
+end

data/lib/thredded/html_pipeline/kramdown_filter.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'kramdown'
+module Thredded
+  module HtmlPipeline
+    class KramdownFilter < ::HTML::Pipeline::TextFilter
+      class << self
+        attr_accessor :options
+      end
+
+      # See http://kramdown.gettalong.org/options.html
+      self.options = {
+        input: 'GFM',
+        gfm_quirks: 'paragraph_end',
+        # Smart quotes conflict with @"at mentions". Disable smart quotes.
+        smart_quotes: %w[apos apos quot quot],
+        remove_block_html_tags: false,
+        syntax_highlighter: nil
+      }
+
+      def initialize(text, context = nil, result = nil)
+        super text, context, result
+        if @text.frozen?
+          @text = @text.delete("\r")
+        else
+          @text.delete! "\r"
+        end
+      end
+
+      # Convert Markdown to HTML using the best available implementation
+      # and convert into a DocumentFragment.
+      def call
+        result = Kramdown::Document.new(@text, self.class.options.deep_merge(context[:kramdown_options] || {})).to_html
+        result.rstrip!
+        result
+      end
+    end
+  end
+end