elabs 2.0.0.pre

data/db/migrate/20180813000001_create_languages.rb

@@ -0,0 +1,16 @@
+class CreateLanguages < ActiveRecord::Migration[5.2]
+  def change
+    create_table :languages do |t|
+      t.string :iso639_1, size: 2,  default: nil, null: false
+      t.string :name,     size: 45, default: nil, null: false
+      t.integer :albums_count,   default: 0, null: false
+      t.integer :articles_count, default: 0, null: false
+      t.integer :notes_count,    default: 0, null: false
+      t.integer :projects_count, default: 0, null: false
+      t.integer :uploads_count,  default: 0, null: false
+
+      t.index :iso639_1, unique: true
+      t.index :name,     unique: true
+    end
+  end
+end

data/db/migrate/20180813000002_create_tags.rb

@@ -0,0 +1,14 @@
+class CreateTags < ActiveRecord::Migration[5.2]
+  def change
+    create_table :tags do |t|
+      t.string :name, null: false
+      t.integer :albums_count,   default: 0, null: false
+      t.integer :articles_count, default: 0, null: false
+      t.integer :notes_count,    default: 0, null: false
+      t.integer :projects_count, default: 0, null: false
+      t.integer :uploads_count,  default: 0, null: false
+
+      t.index :name, unique: true
+    end
+  end
+end

data/db/migrate/20180813000004_create_licenses.rb

@@ -0,0 +1,17 @@
+class CreateLicenses < ActiveRecord::Migration[5.2]
+  def change
+    create_table :licenses do |t|
+      t.string :name, null: false
+      t.string :url, null: false
+      t.string :tldr_url, null: true
+      t.string :icon, null: false
+      t.integer :albums_count,   default: 0, null: false
+      t.integer :articles_count, default: 0, null: false
+      t.integer :notes_count,    default: 0, null: false
+      t.integer :projects_count, default: 0, null: false
+      t.integer :uploads_count,  default: 0, null: false
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20180813000005_create_reports.rb

@@ -0,0 +1,15 @@
+class CreateReports < ActiveRecord::Migration[5.2]
+  def change
+    create_table :reports do |t|
+      t.string :name
+      t.string :email
+      t.string :url, null: false, default: nil
+      t.text :reason, null: false, default: nil
+      t.boolean :allow_contact
+
+      t.references :user, foreign_key: true
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20180813000006_create_comments.rb

@@ -0,0 +1,15 @@
+class CreateComments < ActiveRecord::Migration[5.2]
+  def change
+    create_table :comments do |t|
+      t.references :content, polymorphic: true
+      t.string :name
+      t.string :email
+      t.text :comment
+      t.boolean :allow_contact
+      t.references :user, foreign_key: true
+      t.boolean :deleted
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20180813000007_create_acts.rb

@@ -0,0 +1,10 @@
+class CreateActs < ActiveRecord::Migration[5.2]
+  def change
+    create_table :acts do |t|
+      t.references :content, polymorphic: true
+      t.string :event
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20180813000008_create_preferences.rb

@@ -0,0 +1,13 @@
+class CreatePreferences < ActiveRecord::Migration[5.2]
+  def change
+    create_table :preferences do |t|
+      t.references :user, foreign_key: true
+      t.boolean :show_nsfw, null: false, default: false
+      t.string  :locale,    null: true,  default: nil
+    end
+
+    Elabs::User.all.each do |user|
+      Preference.create! user: user, show_nsfw: false
+    end
+  end
+end

data/db/migrate/20180813000009_create_active_storage_tables.active_storage.rb

@@ -0,0 +1,26 @@
+# This migration comes from active_storage (originally 20170806125915)
+class CreateActiveStorageTables < ActiveRecord::Migration[5.2]
+  def change
+    create_table :active_storage_blobs do |t|
+      t.string   :key,        null: false
+      t.string   :filename,   null: false
+      t.string   :content_type
+      t.text     :metadata
+      t.bigint   :byte_size,  null: false
+      t.string   :checksum,   null: false
+      t.datetime :created_at, null: false
+
+      t.index [:key], unique: true
+    end
+
+    create_table :active_storage_attachments do |t|
+      t.string     :name,     null: false
+      t.references :record,   null: false, polymorphic: true, index: false
+      t.references :blob,     null: false
+
+      t.datetime :created_at, null: false
+
+      t.index %i[record_type record_id name blob_id], name: 'index_active_storage_attachments_uniqueness', unique: true
+    end
+  end
+end

data/db/migrate/20180813000010_create_albums.rb

@@ -0,0 +1,23 @@
+class CreateAlbums < ActiveRecord::Migration[5.2]
+  def change
+    create_table :albums do |t|
+      t.string :name,               null: false, default: nil
+      t.text :description,          null: false, default: nil
+      t.boolean :sfw,               null: false, default: false
+      t.boolean :published,         null: false, default: false
+      t.boolean :locked,            null: false, default: false
+      t.boolean :hidden_in_history, null: false, default: false
+      t.integer :uploads_count,     null: false, default: 0
+
+      t.references :user,     foreign_key: true
+      t.references :license,  foreign_key: true
+      t.references :language, foreign_key: true
+
+      t.datetime :published_at,     null: true
+      t.timestamps
+    end
+
+    create_join_table :albums, :tags
+    add_index :albums_tags, %i[album_id tag_id], unique: true
+  end
+end

data/db/migrate/20180813000011_create_articles.rb

@@ -0,0 +1,23 @@
+class CreateArticles < ActiveRecord::Migration[5.2]
+  def change
+    create_table :articles do |t|
+      t.string  :title,             null: false, default: nil
+      t.string  :excerpt,           null: false, default: nil
+      t.text    :content,           null: false, default: nil
+      t.boolean :sfw,               null: false, default: false
+      t.boolean :published,         null: false, default: false
+      t.boolean :locked,            null: false, default: false
+      t.boolean :hidden_in_history, null: false, default: false
+
+      t.references :user,     foreign_key: true
+      t.references :license,  foreign_key: true
+      t.references :language, foreign_key: true
+
+      t.datetime :published_at,     null: true
+      t.timestamps
+    end
+
+    create_join_table :articles, :tags
+    add_index :articles_tags, %i[article_id tag_id], unique: true
+  end
+end

data/db/migrate/20180813000012_create_notes.rb

@@ -0,0 +1,21 @@
+class CreateNotes < ActiveRecord::Migration[5.2]
+  def change
+    create_table :notes do |t|
+      t.text :content,              null: false, default: nil
+      t.boolean :sfw,               null: false, default: false
+      t.boolean :published,         null: false, default: false
+      t.boolean :locked,            null: false, default: false
+      t.boolean :hidden_in_history, null: false, default: false
+
+      t.references :user,     foreign_key: true
+      t.references :license,  foreign_key: true
+      t.references :language, foreign_key: true
+
+      t.datetime :published_at,     null: true
+      t.timestamps
+    end
+
+    create_join_table :notes, :tags
+    add_index :notes_tags, %i[note_id tag_id], unique: true
+  end
+end

data/db/migrate/20180813000013_create_uploads.rb

@@ -0,0 +1,26 @@
+class CreateUploads < ActiveRecord::Migration[5.2]
+  def change
+    create_table :uploads do |t|
+      t.string  :title,             null: false, default: nil
+      t.text    :description,       null: false, default: nil
+      t.boolean :sfw,               null: false, default: false
+      t.boolean :published,         null: false, default: false
+      t.boolean :locked,            null: false, default: false
+      t.boolean :hidden_in_history, null: false, default: false
+
+      t.references :user,     foreign_key: true
+      t.references :license,  foreign_key: true
+      t.references :language, foreign_key: true
+
+      t.datetime :published_at,     null: true
+      t.timestamps
+    end
+
+    create_join_table :albums, :uploads
+    add_index :albums_uploads, %i[album_id upload_id], unique: true
+
+    create_join_table :uploads, :tags
+    rename_table :tags_uploads, :uploads_tags
+    add_index :uploads_tags, %i[upload_id tag_id], unique: true
+  end
+end

data/db/migrate/20180813000014_create_projects.rb

@@ -0,0 +1,44 @@
+class CreateProjects < ActiveRecord::Migration[5.2]
+  def change
+    create_table :projects do |t|
+      t.string :name,              null: false, default: nil
+      t.string :short_description, null: false, default: nil
+      t.text :description,         null: false, default: nil
+      t.string :main_url
+      t.boolean :sfw,               null: false, default: false
+      t.boolean :published,         null: false, default: false
+      t.boolean :locked,            null: false, default: false
+      t.boolean :hidden_in_history, null: false, default: false
+
+      t.integer :albums_count,   null: false, default: 0
+      t.integer :articles_count, null: false, default: 0
+      t.integer :notes_count,    null: false, default: 0
+      t.integer :uploads_count,  null: false, default: 0
+
+      t.references :user,     foreign_key: true
+      t.references :license,  foreign_key: true
+      t.references :language, foreign_key: true
+
+      t.datetime :published_at,     null: true
+      t.timestamps
+    end
+
+    create_join_table :projects, :albums
+    rename_table :albums_projects, :projects_albums
+    add_index :projects_albums, %i[project_id album_id], unique: true
+
+    create_join_table :projects, :articles
+    rename_table :articles_projects, :projects_articles
+    add_index :projects_articles, %i[project_id article_id], unique: true
+
+    create_join_table :projects, :notes
+    rename_table :notes_projects, :projects_notes
+    add_index :projects_notes,    %i[project_id note_id], unique: true
+
+    create_join_table :projects, :uploads
+    add_index :projects_uploads, %i[project_id upload_id], unique: true
+
+    create_join_table :projects, :tags
+    add_index :projects_tags, %i[project_id tag_id], unique: true
+  end
+end

data/db/seeds.rb

@@ -0,0 +1,10 @@
+# This file should contain all the record creation needed to seed the database with its default values.
+# The data can then be loaded with the rails db:seed command (or created alongside the database with db:setup).
+#
+# Examples:
+#
+#   movies = Movie.create([{ name: 'Star Wars' }, { name: 'Lord of the Rings' }])
+#   Character.create(name: 'Luke', movie: movies.first)
+puts "Seeding for #{Rails.env}"
+require File.join(__dir__, 'seeds_production') if Rails.env.production?
+require File.join(__dir__, 'seeds_development') if Rails.env.development?

data/db/seeds_development.rb

@@ -0,0 +1,21 @@
+# Users
+user = FactoryBot.create :user_known_admin
+
+# Languages
+language = FactoryBot.create :language, iso639_1: 'fr', name: 'Français'
+FactoryBot.create :language, iso639_1: 'en', name: 'English'
+
+# Licenses
+license = FactoryBot.create :license, name: 'Creative Commons by-nc-sa 4.0', url: 'https://creativecommons.org/licenses/by-nc-sa/4.0/', tldr_url: 'https://tldrlegal.com/license/creative-commons-attribution-noncommercial-sharealike-4.0-international-(cc-by-nc-sa-4.0)'
+FactoryBot.create :license, name: 'GPL v2', url: 'https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html', tldr_url: 'https://tldrlegal.com/license/gnu-general-public-license-v2'
+
+# Few tags
+tag = FactoryBot.create :tag, name: 'Ruby'
+
+default_relations = { user: user, language: language, license: license, tags: [tag] }
+# Content
+project = FactoryBot.create :project_published, default_relations.merge(name: 'My first project')
+album   = FactoryBot.create :album_published, default_relations.merge(name: 'My first album', projects: [project])
+FactoryBot.create_list :article_published, 15, default_relations.merge(projects: [project])
+FactoryBot.create_list :note_published, 15, default_relations.merge(projects: [project])
+FactoryBot.create_list :upload_published, 15, default_relations.merge(projects: [project], albums: [album])

data/docs/contributing.md

@@ -0,0 +1,52 @@
+# How to contribute ?
+New ideas and contributions are more than welcome.
+
+Read the [Code of conduct](../CODE_OF_CONDUCT.md) if you're unsure of
+how you're doing things.
+
+The issue tracker is on [gitlab](https://gitlab.com/experimentslabs/engine_elabs/issues). Feel free to open issues here.
+
+## Translations
+Translations are made with Gettext, and are located in `/locale`. If you
+want to create a new translation, execute
+`LANGUAGE=[XX] rake app:gettext:add_language` and edit the new files. You
+can use tools like `poedit`, `virtaal` or `Qt 5 Linguist` to help you in the process.
+
+If you create a new model, use `rake gettext:store_model_attributes` to
+update the list of model attributes names.
+
+Use `rake gettext:find` to update the `.po` files
+
+Rake tasks:
+```
+rake app:gettext:add_language[language]     # add a new language
+rake app:gettext:find                       # Update pot/po files
+rake app:gettext:pack                       # Create mo-files
+rake app:gettext:store_model_attributes     # write the model attributes to <locale_path>/model_attributes.rb
+```
+
+## Git workflow and code submission
+  - Branches `master` and `develop` are _fast-forward_ only.
+  - Make all the MR against `develop` or a release branch if it exists.
+  - Every MR should pass the test suite.
+
+## Testing
+This project uses various tools to enforce code consistency and to run tests:
+
+  - [Rubocop](http://batsov.com/rubocop/) to check the code style. Run
+    `bundle exec rubocop` or `bundle exec rubocop -a` to fix some errors
+    automatically.
+  - [Brakeman](https://brakemanscanner.org/), to check the code against
+    known vulnerabilities and possible security issues. You can launch
+    it locally with `bundle exec brakeman`.
+  - [RSpec](http://rspec.org/) for unit test. You can launch it locally
+    with `bundle exec rspec`.
+  - [Cucumber](https://cucumber.io/) for integration tests. Run
+    `bundle exec cucumber` locally to test the code.
+  - [Eslint](https://eslint.org/) for JS code style. Launch
+    `yarn run lint:js` or `yarn run lint:js-fix` to check locally. It's
+    not perfect, but it helps.
+  - [StyleLint](http://stylelint.io/) for SCSS code style. Run
+    `yarn run lint:sass` or `yarn run lint:sass-fix` locally.
+  - [Haml-lint](https://github.com/brigade/haml-lint) for views
+    consistency. Run `bundle exec haml-lint`.

data/docs/cucumber_terms.md

@@ -0,0 +1,9 @@
+# Feature terms
+This document lists the different terms used in the features for clarity and reference.
+
+User-related terms
+- user: someone visiting the website, registered or not
+- visitor: unregistered user
+- member: registered user
+- maintainer: website owner
+- administrator: a member with admin rights

data/docs/migrating.md

@@ -0,0 +1,4 @@
+# Migration guide
+
+## From 1.0.1 to 2.0.0
+No one ever used 1.0.0 in production, so there is no guide for it :)

data/docs/overriding.md

@@ -0,0 +1,20 @@
+# Overriding Elabs engine
+
+## Views
+To override views, run `rails g elabs:views` and
+`rails g elabs:devise_views`. This will copy all the views in
+`app/views/elabs`. You will be able to edit them.
+
+If you want to override the style but keep the views, you can run
+`rails g elabs:assets`. This will copy CSS and JS files in
+`app/assets/javascripts/elabs` and `app/assets/stylesheets/elabs`.
+You will need the [Knacss](https://www.knacss.com) framework and other
+things from node modules. Install them with yarn (`package.json` should
+have been copied during the [installation](setup.md).
+
+## Models, controllers
+Sadly, we have not tested those parts for now. It would require some work
+to complete the initializer to be able to use custom models; and a work
+on the routes system, to only include the routes you need.
+
+Contributions are welcome.

data/docs/setup.md

@@ -0,0 +1,136 @@
+# Installation
+
+## Pre-requisites
+
+- ruby 2.5
+- PostgreSQL (not tested with Mysql, not usable with sqlite in the
+  current state)
+- NodeJS 8 and Yarn **if** you want to use the default views
+- ImageMagick and ffmpeg **if** you want to use the default views
+
+Additionally, to compile some native ruby extensions, you will need some
+development libraries, as, for an ubuntu 18.04: `build-essential`,
+`libpq-dev`, `libxml2-dev`
+
+## On a new Rails app
+Create a new Rails application using the Rails generator:
+
+```shell
+rail new myapp -d postgresql
+cd myapp
+```
+
+### Gems
+
+Add the Elabs required gems to the `Gemfile`:
+
+```rb
+# User authentication
+gem 'devise'
+# Pagination
+gem 'kaminari'
+# Translations
+gem 'gettext_i18n_rails'
+# Engine
+gem 'elabs'
+
+# If you want to use the default views:
+gem 'active_link_to'
+gem 'haml-rails'
+gem 'mini_magick'
+```
+
+Execute `bundle install` to install them.
+
+### Setup Devise
+
+Devise is the only authentication solution supported by Elabs for now. The model used for users **have to be `User`**.
+
+_Following the [Devise documentation](https://github.com/plataformatec/devise#getting-started):_
+
+- You need to run the generator: `rails generate devise:install`.
+- At this point, a number of instructions will appear in the console. Among these instructions, you'll need to set up the default URL options for the Devise mailer in each environment. Here is a possible configuration for `config/environments/development.rb`: `config.action_mailer.default_url_options = { host: 'localhost', port: 3000 }`.
+  The generator will install an initializer which describes ALL of Devise's configuration options. It is *imperative* that you take a look at it. When you are done, you are ready to add Devise to any of your models using the generator.
+- Generate the User model: `rails generate devise User`
+  The generator also configures your `config/routes.rb` file to point to the Devise controller, but we will overwrite it later.
+- Next, check the User model for any additional configuration options you might want to add, such as confirmable or lockable. If you add an option, be sure to inspect the migration file (created by the generator if your ORM supports them) and uncomment the appropriate section. For example, if you add the confirmable option in the model, you'll need to uncomment the Confirmable section in the migration.
+
+### Setup Elabs
+Once Devise is set up, change the `User` model to extend `Elabs::User` instead
+of `ApplicationRecord`.
+
+Elabs comes with rake tasks to quickly get ready:
+
+- Copy migrations: `rails elabs:install:migrations`, will copy all the
+  migrations in `db/migrate`
+- Copy initializer and other required files: `rails g elabs:install`.
+  Accept to overwrite the `package.json` file **if** you want to use the
+  default views.
+- Edit `config/database.yml` to suit your needs.
+- Run `rails db:create` and `rails db:migrate`
+
+If you want to use the default views, you have to copy some assets from
+elabs:
+
+- Copy custom devise mailer views: `rails g elabs:devise_views`
+- Copy required assets: `rails g elabs:required_assets`
+
+### Routes
+
+Update `config/routes.rb` to look like this:
+
+```rb
+# config/routes.rb
+Rails.application.routes.draw do
+  # Elabs routes. Replace '/' by any prefix, depending on what you want.
+  mount Elabs::Engine, at: '/'
+
+  # Home page (or whatever suits your needs. I.e.: 'elabs/projects#index', ...)
+  root 'elabs/acts#index'
+end
+```
+
+### Default views and assets
+If you want to use the default views, you'll need to install the node
+dependencies with yarn: `yarn install`
+
+Update application manifests to use Elabs assets too:
+
+```rb
+# app/assets/javascripts/application.js
+// [...]
+//= require elabs/application
+```
+
+```rb
+# app/assets/stylesheets/application.css
+ * [...]
+ *= require elabs/application
+```
+
+### Create an administrator
+Admins are people with `admin` role. Open a Rails console and create your
+first user.
+```rb
+User.create username: 'admin', role: 'admin', email: 'admin@yoursite.com', password: 'SomePassword'
+```
+
+An other way is to create an account from the web interface and edit it
+in the rails console:
+
+```rb
+User.last.update(role: 'admin')
+```
+
+### Done !
+
+Start to develop your site !
+
+```rb
+rails s
+```
+
+Now, login with the admin account and create at least a language and a license.
+
+## On an existing Rails app
+**This section needs feedback :)**