thredded 0.1.0 → 0.2.2

data/lib/thredded/private_topic_user_permissions.rb

@@ -0,0 +1,26 @@
+module Thredded
+  class PrivateTopicUserPermissions
+    def initialize(private_topic, user, _user_details)
+      @private_topic = private_topic
+      @user = user
+    end
+
+    def readable?
+      @private_topic.users.include?(@user)
+    end
+
+    def manageable?
+      user_started_topic?
+    end
+
+    def creatable?
+      !@user.thredded_anonymous?
+    end
+
+    private
+
+    def user_started_topic?
+      @user.id == @private_topic.user_id
+    end
+  end
+end

data/lib/thredded/search_parser.rb

@@ -0,0 +1,45 @@
+module Thredded
+  class SearchParser
+    def initialize(query)
+      @query = query
+      @keywords = %w(in by order)
+    end
+
+    def parse
+      parsed_input = parse_keywords
+      parsed_input['text'] = parse_text
+      parsed_input
+    end
+
+    def parse_keywords
+      found_terms_hash = {}
+
+      @keywords.each do |keyword|
+        regex = Regexp.new(keyword + '\s*:\s*\w+', Regexp::IGNORECASE)
+        keyword_scan = @query.scan(regex)
+        @query = @query.gsub(regex, '')
+
+        if keyword_scan.present?
+          keyword_scan.each do |term|
+            keyword_term = term.gsub(' ', '').split(':')
+
+            if found_terms_hash[keyword].nil?
+              found_terms_hash[keyword] = []
+            end
+
+            found_terms_hash[keyword] << keyword_term[1]
+          end
+        end
+      end
+
+      found_terms_hash
+    end
+
+    def parse_text
+      regex = Regexp.new('\"[^"]*\"')
+      found_terms = @query.scan(regex)
+      @query = @query.sub(regex, '')
+      found_terms.concat(@query.split(/\s+/))
+    end
+  end
+end

data/lib/thredded/search_sql_builder.rb

@@ -0,0 +1,21 @@
+require 'thredded/topic_sql_builder'
+require 'thredded/post_sql_builder'
+
+module Thredded
+  class SearchSqlBuilder
+    def initialize(query, messageboard)
+      @topic_builder = TopicSqlBuilder.new(query, messageboard)
+      @post_builder = PostSqlBuilder.new(query, messageboard)
+      @order_by = 'ORDER BY updated_at DESC'
+    end
+
+    def build
+      [
+        'SELECT * FROM thredded_topics WHERE id IN (', @post_builder.sql,
+        'UNION', @topic_builder.sql,
+        ')', @order_by,
+        'LIMIT 50'
+      ].join(' ')
+    end
+  end
+end

data/lib/thredded/seed_database.rb

@@ -0,0 +1,76 @@
+require 'factory_girl_rails'
+
+# rubocop:disable HandleExceptions
+begin
+  if FactoryGirl.factories.instance_variable_get(:@items).none?
+    require_relative '../../../spec/factories'
+  end
+rescue NameError
+end
+# rubocop:enable HandleExceptions
+
+module Thredded
+  class SeedDatabase
+    attr_reader :user, :users, :messageboard, :topics, :private_topics, :posts
+
+    def self.run(users: 5, topics: 26, posts: (0..20))
+      s = new
+      s.create_messageboard
+      s.create_first_user
+      s.create_users(count: users)
+      s.create_topics(count: topics)
+      s.create_posts(count: posts)
+      s.create_private_posts(count: posts)
+    end
+
+    def create_first_user
+      @user ||= begin
+        ::User.first ||
+          ::User.create(name: 'joe', email: 'joe@example.com')
+      end
+    end
+
+    def create_users(count: 5)
+      @users = [user] + FactoryGirl.create_list(:user, count)
+    end
+
+    def create_messageboard
+      @messageboard = FactoryGirl.create(
+        :messageboard,
+        name:        'Main Board',
+        slug:        'main-board',
+        description: 'A board is not a board without some posts'
+      )
+    end
+
+    def create_topics(count: 26)
+      @topics = FactoryGirl.create_list(
+        :topic, count,
+        messageboard: messageboard,
+        user:         users.sample,
+        last_user:    users.sample)
+
+      @private_topics = FactoryGirl.create_list(
+        :private_topic, count,
+        user:         users.sample,
+        last_user:    users.sample,
+        users:        [user])
+    end
+
+    def create_posts(count: (0..30))
+      @posts = topics.flat_map do |topic|
+        (count.min + rand(count.max + 1)).times do
+          FactoryGirl.create(:post, postable: topic, messageboard: messageboard, user: users.sample)
+        end
+      end
+    end
+
+    def create_private_posts(count: (0..30))
+      @private_posts = private_topics.flat_map do |topic|
+        (count.min + rand(count.max + 1)).times do
+          FactoryGirl.create(:private_post, postable: topic, user: users.sample)
+        end
+      end
+    end
+  end
+end

data/lib/thredded/table_sql_builder.rb

@@ -0,0 +1,41 @@
+require 'thredded/search_parser'
+module Thredded
+  class TableSqlBuilder
+    def initialize(query, messageboard)
+      @terms = SearchParser.new(query).parse
+      @scope = Thredded::Topic.select(:id).where(messageboard_id: messageboard.id)
+      @search_categories = @search_users = @search_text = nil
+    end
+
+    def sql
+      apply_filters
+      @scope.to_sql
+    end
+
+    protected
+
+    def categories
+      @search_categories ||=
+        if @terms['in']
+          DbTextSearch::CaseInsensitiveEq.new(Category, :name)
+            .find(@terms['in']).pluck(:id)
+        else
+          []
+        end
+    end
+
+    def users
+      @search_users ||=
+        if @terms['by']
+          DbTextSearch::CaseInsensitiveEq.new(Thredded.user_class, Thredded.user_name_column)
+            .find(@terms['by']).pluck(:id)
+        else
+          []
+        end
+    end
+
+    def text
+      @terms['text']
+    end
+  end
+end

data/lib/thredded/topic_sql_builder.rb

@@ -0,0 +1,11 @@
+require 'thredded/table_sql_builder'
+
+module Thredded
+  class TopicSqlBuilder < TableSqlBuilder
+    def apply_filters
+      @scope = @scope.joins(:topic_categories).where(category_id: categories) if categories.present?
+      @scope = @scope.where(user_id: users) if users.present?
+      @scope = DbTextSearch::FullTextSearch.new(@scope, :title).find(text) if text.present?
+    end
+  end
+end

data/lib/thredded/topic_user_permissions.rb

@@ -0,0 +1,32 @@
+module Thredded
+  class TopicUserPermissions
+    def initialize(topic, user, _user_details)
+      @topic = topic
+      @messageboard = topic.messageboard
+      @messageboard_user_permission = MessageboardUserPermissions.new(topic.messageboard, user)
+      @user = user
+    end
+
+    def creatable?
+      @messageboard_user_permission.postable?
+    end
+
+    def adminable?
+      @messageboard_user_permission.moderatable?
+    end
+
+    def editable?
+      started_by_user? || adminable?
+    end
+
+    def readable?
+      @messageboard_user_permission.readable?
+    end
+
+    private
+
+    def started_by_user?
+      @topic.user_id == @user.id
+    end
+  end
+end

data/lib/thredded/version.rb

@@ -0,0 +1,3 @@
+module Thredded
+  VERSION = '0.2.2'
+end

data/lib/thredded.rb

@@ -0,0 +1,85 @@
+# Backend
+require 'cancan'
+require 'db_text_search'
+require 'friendly_id'
+require 'html/pipeline'
+require 'html/pipeline/at_mention_filter'
+require 'html/pipeline/bbcode_filter'
+require 'kaminari'
+require 'rb-gravatar'
+require 'active_job'
+
+# Asset compilation
+require 'autoprefixer-rails'
+require 'autosize/rails'
+require 'jquery/rails'
+require 'rails-timeago'
+require 'select2-rails'
+require 'sprockets/es6'
+
+require 'thredded/engine'
+require 'thredded/errors'
+require 'thredded/messageboard_user_permissions'
+require 'thredded/post_user_permissions'
+require 'thredded/private_topic_user_permissions'
+require 'thredded/topic_user_permissions'
+require 'thredded/search_sql_builder'
+require 'thredded/main_app_route_delegator'
+
+module Thredded
+  mattr_accessor :user_class,
+    :user_name_column,
+    :avatar_url,
+    :email_incoming_host,
+    :email_from,
+    :email_outgoing_prefix,
+    :email_reply_to,
+    :user_path,
+    :layout,
+    :active_user_threshold
+
+  # @return [Symbol] The name of the moderator flag column on the users table for the default permissions model
+  mattr_accessor :moderator_column
+
+  # @return [Symbol] The name of the admin flag column on the users table for the default permissions model
+  mattr_accessor :admin_column
+
+  self.user_name_column = :name
+  self.avatar_url = ->(user) { Gravatar.src(user.email, 128, 'mm') }
+  self.active_user_threshold = 5.minutes
+  self.layout = 'thredded/application'
+  self.email_reply_to = -> postable { "#{postable.hash_id}@#{Thredded.email_incoming_host}" }
+  self.moderator_column = :admin
+  self.admin_column = :admin
+
+  # @return [Class<Thredded::UserExtender>] the user class from the host application.
+  def self.user_class
+    if @@user_class.is_a?(Class)
+      fail 'Please use a string instead of a class'
+    end
+
+    if @@user_class.is_a?(String)
+      begin
+        Object.const_get(@@user_class)
+      rescue NameError
+        @@user_class.constantize
+      end
+    end
+  end
+
+  # @param view_context [Object] context to execute the lambda in.
+  # @param user [Thredded.user_class]
+  # @return [String] path to the user evaluated in the specified context.
+  def self.user_path(view_context, user)
+    if @@user_path.respond_to? :call
+      view_context.instance_exec(user, &@@user_path)
+    else
+      '/'
+    end
+  end
+
+  # Whether the layout is a thredded layout as opposed to the application layout.
+  def self.standalone_layout?
+    layout.is_a?(String) && layout.start_with?('thredded/')
+  end
+end

data/thredded.gemspec

@@ -0,0 +1,68 @@
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+
+require 'thredded/version'
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = 'thredded'
+  s.version     = Thredded::VERSION
+  s.authors     = ['Joel Oliveira', 'Gleb Mazovetskiy']
+  s.email       = ['joel@thredded.com', 'glex.spb@gmail.com']
+  s.homepage    = 'https://www.thredded.com'
+  s.summary     = 'A messageboard engine'
+  s.license     = 'MIT'
+  s.description = 'A messageboard engine for Rails 4.1+ apps'
+
+  s.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec|script)/|^\.}) } -
+    %w(Dockerfile docker-compose.yml Rakefile Gemfile shared.gemfile)
+
+  # backend
+  s.add_dependency 'bbcoder', '~> 1.0'
+  s.add_dependency 'cancancan'
+  s.add_dependency 'db_text_search', '~> 0.1.1'
+  s.add_dependency 'friendly_id'
+  s.add_dependency 'html-pipeline'
+  s.add_dependency 'htmlentities'
+  s.add_dependency 'kaminari'
+  s.add_dependency 'nokogiri'
+  s.add_dependency 'rails', '>= 4.1.0'
+  s.add_dependency 'rb-gravatar'
+
+  # html-pipeline dependencies, see https://github.com/jch/html-pipeline#dependencies
+  s.add_dependency 'gemoji'
+  s.add_dependency 'github-markdown'
+  s.add_dependency 'rinku'
+  s.add_dependency 'sanitize'
+
+  # frontend
+  s.add_dependency 'sass', '>= 3.4.21'
+  s.add_dependency 'autoprefixer-rails'
+  s.add_dependency 'rails-timeago'
+  s.add_dependency 'select2-rails', '~> 3.5'
+  s.add_dependency 'autosize-rails'
+  s.add_dependency 'sprockets-es6'
+  s.add_dependency 'jquery-rails'
+
+  # test dependencies
+  s.add_development_dependency 'capybara', '~> 2.4'
+  s.add_development_dependency 'chronic'
+  s.add_development_dependency 'database_cleaner'
+  s.add_development_dependency 'factory_girl_rails'
+  s.add_development_dependency 'faker'
+  s.add_development_dependency 'launchy'
+  s.add_development_dependency 'rspec-rails'
+  s.add_development_dependency 'rubocop', '0.32.0'
+  s.add_development_dependency 'shoulda-matchers', '~> 2.7'
+  s.add_development_dependency 'test-unit'
+  s.add_development_dependency 'timecop'
+
+  # dummy app dependencies
+  s.add_development_dependency 'mysql2'
+  s.add_development_dependency 'pg'
+  s.add_development_dependency 'sqlite3'
+  s.add_development_dependency 'puma'
+
+  # dummy app frontend
+  s.add_development_dependency 'jquery-turbolinks'
+  s.add_development_dependency 'turbolinks'
+end