discourse_dev 0.0.1 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2aba4e03e170bb935d21b11561bad7ec4fa6863b1c93985cf341a8415a7b181
-  data.tar.gz: dfb5e511e0564a2e2fec192834f0f21eb21e9c044f4132eb39edba489bc5b164
+  metadata.gz: e7cf21a4b27818d1c6c02ce68b6f3fec67fec0b5c7ce070203c4db6bec1e1e72
+  data.tar.gz: 7bcd79d041f43cf6ed4843c2a3fe9f20bba915682516586064a0356acb5246df
 SHA512:
-  metadata.gz: 1ef8f8c750db41437f73e84e77a12e51360b4052b3be3e620222b7786c9e255bf81883c986dbb8be3a0cfc9c9e8d3dab5a5c5468e2afeb1e1c3657b0b2c25a36
-  data.tar.gz: 7b40a195bd4df36c465d311dc71eee03bdc85f89192b5a937ec50a17fe842feadeec233e1328da3ca2be7386f44e334cef3756488fc01b9052ca3214fd933202
+  metadata.gz: f964c9b509c0e219aff2161e49fc7d468861fefc85e6ce0a68250fbdfd2ca6d06d32ee7bf0b153ae99eb1dc9be0a1c4694752ec60ee7b0c71143d0283ebd5c15
+  data.tar.gz: 207d473198144df8997a72eb9ab6f9070b24b924c6600be546d6bef2aeb26076c633b781caba9fb69590a2c99807004b0c19a49026f588d2cc7ae0470fa391b5

data/README.md

@@ -1 +1,15 @@
 # Discourse Dev
+
+![Gem](https://img.shields.io/gem/v/discourse_dev)
+
+Rake helper tasks for Discourse developers.
+
+## Available Rake Tasks
+
+* `dev:reset`
+* `dev:config`
+* `dev:populate`
+* `groups:populate`
+* `users:populate`
+* `categories:populate`
+* `topics:populate`

data/config/routes.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+DiscourseDev::Engine.routes.draw do
+  get ':username_or_email/become' => 'admin/impersonate#create', constraints: AdminConstraint.new
+end

data/discourse_dev.gemspec

@@ -10,8 +10,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Vinoth Kannan"]
   spec.email         = ["svkn.87@gmail.com"]
 
-  spec.summary       = %q{Rake helper for Discourse developers}
-  spec.description   = %q{Rake helper for Discourse developers}
+  spec.summary       = %q{Rake helper tasks for Discourse developers}
+  spec.description   = %q{Rake helper tasks for Discourse developers}
   spec.homepage      = "https://github.com/discourse/discourse_dev"
   spec.license       = "MIT"
 
@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "faker", "~> 2.16"
 
   spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", ">= 12.3.3"
 
   spec.required_ruby_version = '>= 2.6.0'
 end

data/lib/discourse_dev.rb

@@ -8,5 +8,6 @@ I18n.load_path += Dir[File.join(__dir__, 'faker', 'locales', '**/*.yml')]
 I18n.reload! if I18n.backend.initialized?
 
 module DiscourseDev
-  require 'discourse_dev/railtie' if defined?(Rails)
+  require 'discourse_dev/railtie'
+  require 'discourse_dev/engine'
 end

data/lib/discourse_dev/category.rb

@@ -9,21 +9,52 @@ module DiscourseDev
 
     def initialize(count = DEFAULT_COUNT)
       super(::Category, count)
+      @parent_category_ids = ::Category.where(parent_category_id: nil).pluck(:id)
     end
 
     def data
-      name = Faker::Name.name
-      email = Faker::Internet.email(name: name)
-      username = Faker::Internet.username(specifier: name)[0, SiteSetting.max_username_length]
-      username_lower = username.downcase
+      name = Faker::Discourse.unique.category
+      parent_category_id = nil
+
+      if Faker::Boolean.boolean(true_ratio: 0.6)
+        offset = Faker::Number.between(from: 0, to: @parent_category_ids.count - 1)
+        parent_category_id = @parent_category_ids[offset]
+        @permissions = ::Category.find(parent_category_id).permissions_params.presence
+      else
+        @permissions = nil
+      end
 
       {
         name: name,
-        email: email,
-        username: username,
-        username_lower: username_lower,
-        trust_level: Faker::Number.between(from: 1, to: 4)
+        description: Faker::Lorem.paragraph,
+        user_id: ::Discourse::SYSTEM_USER_ID,
+        color: Faker::Color.hex_color.last(6),
+        parent_category_id: parent_category_id
       }
     end
+
+    def permissions
+      return @permissions if @permissions.present?
+      return { everyone: :full } if Faker::Boolean.boolean(true_ratio: 0.75)
+        
+      permission = {}
+      group = Group.random
+      permission[group.id] = Faker::Number.between(from: 1, to: 3)
+
+      permission
+    end
+
+    def create!
+      super do |category|
+        category.set_permissions(permissions)
+        category.save!
+
+        @parent_category_ids << category.id if category.parent_category_id.blank?
+      end
+    end
+
+    def self.random
+      super(::Category)
+    end
   end
 end

data/lib/discourse_dev/config.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require 'rails'
+
+module DiscourseDev
+  class Config
+    attr_reader :config, :default_config
+
+    def initialize
+      @default_config = YAML.load_file(File.join(File.expand_path(__dir__), "config.yml"))
+      file_path = File.join(Rails.root, "config", "dev.yml")
+
+      if File.exists?(file_path)
+        @config = YAML.load_file(file_path)
+      else
+        @config = {}
+      end
+    end
+
+    def update!
+      update_site_settings
+      create_admin_user
+      set_seed
+    end
+
+    def update_site_settings
+      puts "Updating site settings..."
+
+      site_settings = config["site_settings"] || {}
+
+      site_settings.each do |key, value|
+        puts "#{key} = #{value}"
+        SiteSetting.set(key, value)
+      end
+
+      keys = site_settings.keys
+
+      default_config["site_settings"].each do |key, value|
+        next if keys.include?(key)
+
+        puts "#{key} = #{value}"
+        SiteSetting.set(key, value)
+      end
+
+      SiteSetting.refresh!
+    end
+
+    def create_admin_user
+      puts "Creating default admin user account..."
+
+      settings = config["admin"]
+
+      if settings.present?
+        email = settings["email"]
+
+        admin = ::User.create!(
+          email: email,
+          username: settings["username"] || UserNameSuggester.suggest(email),
+          password: settings["password"]
+        )
+        admin.grant_admin!
+        if admin.trust_level < 1
+          admin.change_trust_level!(1)
+        end
+        admin.email_tokens.update_all confirmed: true
+        admin.activate
+      else
+        Rake::Task['admin:create'].invoke
+      end
+    end
+
+    def set_seed
+      seed = config["seed"] || default_config["seed"] || 1
+      Faker::Config.random = Random.new(seed)
+    end
+  end
+end

data/lib/discourse_dev/config.yml

@@ -0,0 +1,4 @@
+site_settings:
+  tagging_enabled: true
+  verbose_discourse_connect_logging: true
+seed: 1

data/lib/discourse_dev/engine.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DiscourseDev
+  class Engine < Rails::Engine; end
+end

data/lib/discourse_dev/group.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'discourse_dev/record'
+require 'rails'
+require 'faker'
+
+module DiscourseDev
+  class Group < Record
+
+    DEFAULT_COUNT = 15.freeze
+
+    def initialize(count = DEFAULT_COUNT)
+      super(::Group, count)
+    end
+
+    def data
+      {
+        name: Faker::Discourse.unique.group,
+        public_exit: Faker::Boolean.boolean,
+        public_admission: Faker::Boolean.boolean,
+        primary_group: Faker::Boolean.boolean
+      }
+    end
+
+    def create!
+      super do |group|
+        if Faker::Boolean.boolean
+          group.add_owner(::Discourse.system_user)
+          group.allow_membership_requests = true
+          group.save!
+        end
+      end
+    end
+
+    def self.random
+      super(::Group)
+    end
+  end
+end

data/lib/discourse_dev/post.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require 'discourse_dev/record'
+require 'faker'
+
+module DiscourseDev
+  class Post < Record
+
+    attr_reader :topic
+
+    def initialize(topic, count = DEFAULT_COUNT)
+      super(::Post, count)
+      @topic = topic
+
+      category = topic.category
+      unless category.groups.blank?
+        group_ids = category.groups.pluck(:id)
+        @user_ids = ::GroupUser.where(group_id: group_ids).pluck(:user_id)
+        @user_count = @user_ids.count
+      end
+    end
+
+    def data
+      {
+        topic_id: topic.id,
+        raw: Faker::Markdown.sandwich(sentences: 5),
+        skip_validations: true
+      }
+    end
+
+    def create!
+      begin
+        PostCreator.new(user, data).create!
+      rescue ActiveRecord::RecordNotSaved => e
+        puts e
+      end
+    end
+
+    def user
+      return User.random if topic.category.groups.blank?
+      return Discourse.system_user if @user_ids.blank?
+
+      position = Faker::Number.between(from: 0, to: @user_count - 1)
+      ::User.find(@user_ids[position])
+    end
+
+    def populate!
+      @count.times do |i|
+        @index = i
+        create!
+      end
+    end
+
+    def self.add_replies!(args)
+      if !args[:topic_id]
+        puts "Topic ID is required. Aborting."
+        return
+      end
+
+      if !::Topic.find_by_id(args[:topic_id])
+        puts "Topic ID does not match topic in DB, aborting."
+        return
+      end
+
+      topic = ::Topic.find_by_id(args[:topic_id])
+      count = args[:count] ? args[:count].to_i : 50
+
+      puts "Creating #{count} replies in '#{topic.title}'"
+
+      count.times do |i|
+        @index = i
+        begin
+          reply = {
+            topic_id: topic.id,
+            raw: Faker::Markdown.sandwich(sentences: 5),
+            skip_validations: true
+          }
+          PostCreator.new(User.random, reply).create!
+        rescue ActiveRecord::RecordNotSaved => e
+          puts e
+        end
+      end
+
+      puts "Done!"
+    end
+
+  end
+end

data/lib/discourse_dev/record.rb

@@ -11,28 +11,56 @@ module DiscourseDev
     attr_reader :model, :type
 
     def initialize(model, count = DEFAULT_COUNT)
+      Faker::Discourse.unique.clear
       @model = model
       @type = model.to_s
       @count = count
+      @index = nil
     end
 
     def create!
-      model.create!(data)
-      putc "."
+      record = model.create!(data)
+      yield(record) if block_given?
     end
 
     def populate!
-      puts "Creating #{count} sample #{type.downcase}s"
-      count.times { create! }
+      if current_count >= @count
+        puts "Already have #{@count}+ #{type.downcase} records."
+
+        Rake.application.top_level_tasks.each do |task_name|
+          Rake::Task[task_name].reenable
+        end
+
+        Rake::Task['dev:repopulate'].invoke
+        return
+      end
+
+      puts "Creating #{@count} sample #{type.downcase} records"
+
+      @count.times do |i|
+        @index = i
+        create!
+        putc "."
+      end
+
       puts
     end
 
-    def count
-      @count || DEFAULT_COUNT
+    def index
+      @index
+    end
+
+    def current_count
+      model.count
     end
 
     def self.populate!
       self.new.populate!
     end
+
+    def self.random(model)
+      offset = Faker::Number.between(from: 0, to: model.count - 1)
+      model.offset(offset).first
+    end
   end
 end

data/lib/discourse_dev/tag.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'discourse_dev/record'
+require 'rails'
+require 'faker'
+
+module DiscourseDev
+  class Tag < Record
+
+    def initialize(count = DEFAULT_COUNT)
+      super(::Tag, count)
+    end
+
+    def data
+      {
+        name: Faker::Discourse.unique.tag,
+      }
+    end
+  end
+end

data/lib/discourse_dev/tasks/dev.rake

@@ -11,12 +11,33 @@ task 'dev:reset' => ['db:load_config'] do |_, args|
   check_environment!
 
   Rake::Task['db:migrate:reset'].invoke
-  Rake::Task['admin:create'].invoke
+  Rake::Task['dev:config'].invoke
   Rake::Task['dev:populate'].invoke
 end
 
+desc 'Initialize development environment'
+task 'dev:config' => ['db:load_config'] do |_, args|
+  DiscourseDev::Config.new.update!
+end
+
 desc 'Populate sample content for development environment'
 task 'dev:populate' => ['db:load_config'] do |_, args|
+  Rake::Task['groups:populate'].invoke
   Rake::Task['users:populate'].invoke
+  Rake::Task['categories:populate'].invoke
+  Rake::Task['tags:populate'].invoke
   Rake::Task['topics:populate'].invoke
 end
+
+desc 'Repopulate sample datas in development environment'
+task 'dev:repopulate' => ['db:load_config'] do |_, args|
+  require 'highline/import'
+
+  answer = ask("Do you want to repopulate the database with fresh data? It will recreate DBs and run migration from scratch before generating all the samples. (Y/n)  ")
+
+  if (answer == "" || answer.downcase == 'y')
+    Rake::Task['dev:reset'].invoke
+  else
+    puts "You can run `dev:reset` rake task to do this repopulate action anytime."
+  end
+end

data/lib/discourse_dev/tasks/populate.rake

@@ -1,11 +1,31 @@
 # frozen_string_literal: true
 
+desc 'Creates sample categories'
+task 'groups:populate' => ['db:load_config'] do |_, args|
+  DiscourseDev::Group.populate!
+end
+
 desc 'Creates sample user accounts'
 task 'users:populate' => ['db:load_config'] do |_, args|
   DiscourseDev::User.populate!
 end
 
+desc 'Creates sample categories'
+task 'categories:populate' => ['db:load_config'] do |_, args|
+  DiscourseDev::Category.populate!
+end
+
+desc 'Creates sample tags'
+task 'tags:populate' => ['db:load_config'] do |_, args|
+  DiscourseDev::Tag.populate!
+end
+
 desc 'Creates sample topics'
 task 'topics:populate' => ['db:load_config'] do |_, args|
   DiscourseDev::Topic.populate!
 end
+
+desc 'Add replies to a topic'
+task 'replies:populate', [:topic_id, :count] => ['db:load_config'] do |_, args|
+  DiscourseDev::Post.add_replies!(args)
+end

data/lib/discourse_dev/topic.rb

@@ -8,26 +8,64 @@ module DiscourseDev
 
     def initialize(count = DEFAULT_COUNT)
       super(::Topic, count)
-      @category_ids = ::Category.pluck(:id)
-      @user_count = ::User.count
     end
 
     def data
       {
-        title: Faker::Lorem.sentence(word_count: 3, supplemental: true, random_words_to_add: 4).chomp(".")[0, SiteSetting.max_topic_title_length],
+        title: title[0, SiteSetting.max_topic_title_length],
         raw: Faker::Markdown.sandwich(sentences: 5),
-        category_id: @category_ids.sample,
+        category: @category.id,
+        tags: tags,
         topic_opts: { custom_fields: { dev_sample: true } },
         skip_validations: true
       }
     end
 
+    def title
+      if index <= I18n.t("faker.discourse.topics").count
+        Faker::Discourse.unique.topic
+      else
+        Faker::Lorem.unique.sentence(word_count: 3, supplemental: true, random_words_to_add: 4).chomp(".")
+      end
+    end
+
+    def tags
+      @tags = []
+
+      Faker::Number.between(from: 0, to: 3).times do
+        @tags << Faker::Discourse.tag
+      end
+
+      @tags.uniq
+    end
+
     def create!
-      offset = rand(@user_count)
-      user = ::User.offset(offset).first
+      @category = Category.random
+      topic = data
+      post = PostCreator.new(user, topic).create!
+
+      if topic[:title] == "Coolest thing you have seen today"
+        reply_count = 99
+      else
+        reply_count = Faker::Number.between(from: 0, to: 12)
+      end
+
+      Post.new(post.topic, reply_count).populate!
+    end
+
+    def user
+      return User.random if @category.groups.blank?
+
+      group_ids = @category.groups.pluck(:id)
+      user_ids = ::GroupUser.where(group_id: group_ids).pluck(:user_id)
+      user_count = user_ids.count
+      position = Faker::Number.between(from: 0, to: user_count - 1)
+      ::User.find(user_ids[position] || Discourse::SYSTEM_USER_ID)
+    end
 
-      PostCreator.new(user, data).create!
-      putc "."
+    def current_count
+      category_definition_topic_ids = ::Category.pluck(:topic_id)
+      ::Topic.where(archetype: :regular).where.not(id: category_definition_topic_ids).count
     end
   end
 end

data/lib/discourse_dev/user.rb

@@ -12,9 +12,9 @@ module DiscourseDev
     end
 
     def data
-      name = Faker::Name.name
-      email = Faker::Internet.email(name: name)
-      username = Faker::Internet.username(specifier: name)[0, SiteSetting.max_username_length]
+      name = Faker::Name.unique.name
+      email = Faker::Internet.unique.email(name: name)
+      username = Faker::Internet.unique.username(specifier: name)[0, SiteSetting.max_username_length]
       username_lower = username.downcase
 
       {
@@ -22,8 +22,24 @@ module DiscourseDev
         email: email,
         username: username,
         username_lower: username_lower,
+        moderator: Faker::Boolean.boolean(true_ratio: 0.1),
         trust_level: Faker::Number.between(from: 1, to: 4)
       }
     end
+
+    def create!
+      super do |user|
+        user.activate
+        Faker::Number.between(from: 0, to: 2).times do
+          group = Group.random
+    
+          group.add(user)
+        end
+      end
+    end
+
+    def self.random
+      super(::User)
+    end
   end
 end

data/lib/discourse_dev/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DiscourseDev
-  VERSION = "0.0.1"
+  VERSION = "0.0.7"
 end

data/lib/faker/discourse.rb

@@ -1,12 +1,26 @@
 # frozen_string_literal: true
 
+require 'faker'
+
 module Faker
   class Discourse < Base
     class << self
 
+      def tag
+        fetch('discourse.tags')
+      end
+
       def category
         fetch('discourse.categories')
       end
+
+      def group
+        fetch('discourse.groups')
+      end
+
+      def topic
+        fetch('discourse.topics')
+      end
     end
   end
 end

data/lib/faker/locales/en.yml

@@ -4,7 +4,6 @@ en:
       categories:
         - movies
         - tech
-        - general
         - videos
         - gaming
         - sports
@@ -19,3 +18,117 @@ en:
         - announcements
         - bug
         - community
+        - Events
+        - Education
+        - General Discussion
+        - News
+        - Suggestions
+        - Introduce Yourself
+        - Frequently Asked Questions
+        - Off-Topic
+        - Expert Advice
+        - Home and Living
+        - Babies and Kids
+        - International
+        - Partners
+        - Getting Started
+        - Creator's Corner
+        - Feature Requests
+        - Other Languages
+        - Travelling
+        - Recipes
+        - Newbies
+        - Covid-19
+        - Resources
+        - Docs
+        - Publishing
+        - Marketplace
+        - Community Guidelines
+        - Archived
+        - Meta
+        - Software and Operating Systems
+        - Arts & Media
+        - Science and Engineering
+        - Quizzes and Challenges
+        - Politics
+        - Roadmap
+        - Share Tips and Tricks
+      groups:
+        - team
+        - designers
+        - authors
+        - contributors
+        - customers
+        - subscribers
+        - creators
+        - translators
+        - editors
+        - developers
+        - publishers
+        - leaders
+        - advertisers
+        - early-birds
+        - partners
+      topics:
+        - Whoa. Check out this crazy paper artwork
+        - What’s the coolest thing you have worked on?
+        - A bear, however hard he tries, grows tubby without exercise
+        - Impressions Games City Builders
+        - Recommended reading for Community and FOSS enthusiasts
+        - Robots are taking our jobs!
+        - Modernizing the antiquated boxing scoring system
+        - Death by poisonous and electric watermelon
+        - D&D Gallery - Prey for Smiley Bob play session [with terrain]
+        - Why is uninhabited land in the US so closed off?
+        - The Room Appreciation Topic
+        - Recommend a great YouTube video
+        - Favorite TV show scene?
+        - Is the Second Amendment still relevant today?
+        - What methods/books did you use to learn Ruby?
+        - What is your favorite TED Video
+        - MLP:FIM Season 3 (spoilers ahoy!)
+        - Do you use a mobile device for ALL your work? Tell me how!
+        - What’s your all-time favorite movie scene?
+        - Enjoyable children’s shows for adults
+        - Totally amped about the 80s
+        - Do microwave ovens kill bacteria?
+        - Most inspirational movie you have ever seen?
+        - Catching all 151 in 2 hours  😀
+        - Charlie The Unicorn 4
+        - Video Games for Pre-Teens?
+        - Online learning
+        - Mark of the Ninja
+        - Funniest thing you’ve seen today?
+        - Coolest thing you have seen today
+        - Share your Hallowe’en pictures
+      tags:
+        - art
+        - code
+        - official
+        - feedback
+        - fun
+        - dev
+        - design
+        - test
+        - blog
+        - cloud
+        - tv
+        - movies
+        - review
+        - news
+        - link
+        - video
+        - photos
+        - lead
+        - mobile
+        - music
+        - release
+        - notes
+        - todo
+        - duplicate
+        - praise
+        - faq
+        - job-application
+        - rfc
+        - email
+        - wiki

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: discourse_dev
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.7
 platform: ruby
 authors:
 - Vinoth Kannan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-04 00:00:00.000000000 Z
+date: 2021-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faker
@@ -42,17 +42,17 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
-description: Rake helper for Discourse developers
+        version: 12.3.3
+description: Rake helper tasks for Discourse developers
 email:
 - svkn.87@gmail.com
 executables: []
@@ -65,11 +65,18 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- config/routes.rb
 - discourse_dev.gemspec
 - lib/discourse_dev.rb
 - lib/discourse_dev/category.rb
+- lib/discourse_dev/config.rb
+- lib/discourse_dev/config.yml
+- lib/discourse_dev/engine.rb
+- lib/discourse_dev/group.rb
+- lib/discourse_dev/post.rb
 - lib/discourse_dev/railtie.rb
 - lib/discourse_dev/record.rb
+- lib/discourse_dev/tag.rb
 - lib/discourse_dev/tasks/dev.rake
 - lib/discourse_dev/tasks/populate.rake
 - lib/discourse_dev/topic.rb
@@ -99,5 +106,5 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Rake helper for Discourse developers
+summary: Rake helper tasks for Discourse developers
 test_files: []