railswiki 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 16ff0c2ac029de418449afc75c8e33fd6af038d7
+  data.tar.gz: 99faf6315a3dc2ea27634d1fdac059e8564ffd86
+SHA512:
+  metadata.gz: 7d2b2c098430a8341a0951d47dc14abfb735667e4f38d5947c49ec5fb0ed08574b4a4341a8d7e4841a600ec56e17237eb43873e501d62e2388e2d21a5fa2a41c
+  data.tar.gz: 97688e4fb4f443f266bbbbe60309771692df6f46725cb2f94d0c240a97b448153c4b45ee4aef6e2f5faa8d40b5d7dd6be0185de46eb00e83f68ad933f3fbbf48

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Jevon Wright
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,185 @@
+# Railswiki
+A wiki engine in Rails 5.
+
+## Usage
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'railswiki'
+
+# for loading secrets
+gem 'figaro'
+gem 'dotenv-rails'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Then enable in your application in `config/routes.rb`:
+```ruby
+Rails.application.routes.draw do
+  mount Railswiki::Engine, at: "/wiki"
+
+  get "/auth/google_login/callback" => "railswiki/sessions#create"
+  get "/auth/google_login" => "railswiki/sessions#create", as: :login
+
+  root to: "railswiki/pages#show", id: "Home"
+end
+```
+
+Install and run migrations:
+
+```bash
+$ rake railties:install:migrations
+$ rake db:migrate
+```
+
+Enable `config/secrets.yml` to load secrets from ENV (using `figaro`):
+
+```yaml
+# config/secrets.yml
+
+# Do not keep production secrets in the repository,
+# instead read values from the environment.
+production:
+  secret_key_base: <%= ENV["SECRET_KEY_BASE"] %>
+```
+
+Set your secrets in a `.env` file in root (using `dotenv-rails`):
+
+```yaml
+SECRET_KEY_BASE: "xyz"
+OAUTH_CLIENT_ID: "xyz"
+OAUTH_CLIENT_SECRET: "xyz"
+```
+
+Get these values by [logging into your Google Developers Console](http://www.jevon.org/wiki/Google_OAuth2_with_Ruby_on_Rails).
+
+Install webpacker, adding `railswiki` as a dependency:
+
+```bash
+$ rails webpacker:install
+$ yarn add https://github.com/soundasleep/railswiki
+$ yarn install
+```
+
+Add to your `app/javascript/packs/application.js`:
+
+```js
+// javascripts
+import SimpleMDE from 'simplemde'
+import Tingle from 'tingle.js'
+
+window.SimpleMDE = SimpleMDE
+window.tingle = Tingle
+
+// stylesheets
+
+// I have NO idea why the src/ is broken but debug/ works - it looks like src/
+// is missing some extra styles that aren't being included properly. who knows.
+// import "simplemde/src/css/simplemde.css"
+import "simplemde/debug/simplemde.css"
+import 'tingle.js/src/tingle.css'
+```
+
+Run `bin/webpack` or `bin/webpack-dev-server` (hot reloading) to compile the webpacker pack.
+
+You can now host locally and visit http://localhost:3000/wiki:
+
+```bash
+$ rails s
+```
+
+## Extending
+
+In your local app, edit the app/assets/javascripts/ and app/assets/stylesheets as normal.
+They will automatically be picked up.
+
+You can also override individual views from _railswiki_ by creating e.g. `app/views/railswiki/pages/show.html.erb`.
+
+### Custom page titles
+
+In `app/helpers/railswiki/title_helper.rb`:
+
+```ruby
+module Railswiki::TitleHelper
+  def title(page_title)
+    page_title = ["My Very First Wiki"] if page_title == ["Home"]
+
+    content_for(:title) { page_title.join(" - ") }
+  end
+end
+```
+
+### Use slugs (/title) rather than Wiki (/wiki/Title)
+
+Create a new initialiser to enable slugs, rather than wiki pages:
+
+```ruby
+# config/initializers/railswiki_slugs.rb
+
+Railswiki::Engine.use_slugs = true
+```
+
+And add to your `routes.rb`, before your `root` route:
+
+```ruby
+get "*path", to: 'railswiki/pages#show', via: :get, as: :slug
+```
+
+## Deploying
+
+Check out [DEPLOY.md](DEPLOY.md) for instructions to deploy using Capistrano onto Apache/Passenger/MySQL.
+
+## Supported
+
+1. Making pages, editing pages
+1. Assigning permissions to users
+1. Uploading files and images, images can be scaled and linked to external URLs
+1. Existing image dialog in wysiwyg editor (uploading images remotely is too hard)
+1. Existing file dialog in wysiwyg editor
+1. Invite users
+1. Prevent navigating/reloading with unsaved changes
+1. Templates can be included using `{{template}}`
+1. Search with `{{Special:Search}}` template
+1. Rails 5.1
+1. Uses yarn/webpack for Javascript assets (though it's a bit messy - [waiting for webpack support for Rails Engines](https://github.com/rails/webpacker/issues/348))
+
+## MVP
+
+1. A nice default style
+1. Put dialog Javascript into assets/, not inline
+
+## TODO
+
+1. Use Ruby 2.4+
+1. Make site accessible to screen readers (like ChromeVox) by default
+1. Allow images to have descriptions, which are used for screen readers
+1. Allow images to be linked as Image:N rather than full paths
+1. Allow files, images to be renamed (change title)
+1. All the schemas require null set
+1. Rspec tests
+2. Cucumber tests
+3. Travis-ci integration
+4. Demo site on Heroku
+5. Screenshot
+1. Uploads [persist across validations](https://github.com/carrierwaveuploader/carrierwave#making-uploads-work-across-form-redisplays) and can be [uploaded from remote URLs](https://github.com/carrierwaveuploader/carrierwave#uploading-files-from-a-remote-location)
+1. Support [strikethrough, pretty code blocks, etc](https://github.com/vmg/redcarpet) and list in Special:Formatting
+1. "What Links Here"
+1. "Page Categories"
+1. Clicking "sign in" at the bottom of the page redirects to the page you were on
+
+## Sites using Railswiki
+
+* http://outerspaces.org.nz ([source](https://github.com/soundasleep/outerspaces))
+
+## Contributing
+
+Contribution directions go here.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,24 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Railswiki'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_tasks'
+

data/app/assets/config/railswiki_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/railswiki .js
+//= link_directory ../stylesheets/railswiki .css

data/app/assets/javascripts/railswiki/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/javascripts/railswiki/histories.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/javascripts/railswiki/invites.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/javascripts/railswiki/pages.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/javascripts/railswiki/sessions.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/javascripts/railswiki/uploaded_files.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/javascripts/railswiki/users.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/stylesheets/railswiki/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/assets/stylesheets/railswiki/histories.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/assets/stylesheets/railswiki/invites.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/assets/stylesheets/railswiki/pages.scss

@@ -0,0 +1,55 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/
+
+.wiki-template {
+  &.wiki-Special_Search {
+    display: inline;
+
+    &, form, div, p, label {
+      display: inline-block;
+      border: 0;
+      padding: 0;
+      clear: none;
+    }
+    p {
+      display: inline;
+      margin: 0;
+    }
+    h3, label, input[type=submit] {
+      display: none;
+    }
+  }
+}
+
+.wiki-Special_Header {
+  float: left;
+  max-width: 50%;
+}
+
+.menu {
+  float: right;
+  max-width: 50%;
+  text-align: right;
+  margin-bottom: 20px;
+
+  p {
+    margin: 0;
+    padding: 0;
+  }
+}
+
+.content {
+  clear: both;
+}
+
+.end-of-content {
+  clear: both;
+}
+
+.error {
+  background: #fcc;
+  border: 1px solid #c99;
+  padding: 1em;
+}

data/app/assets/stylesheets/railswiki/sessions.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/assets/stylesheets/railswiki/uploaded_files.scss

@@ -0,0 +1,54 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/
+
+.insert-image {
+  ul.uploaded-images {
+    list-style: none;
+    margin: 0;
+    padding: 0;
+
+    li {
+      display: inline-block;
+      width: 100px;
+      height: 100px;
+      cursor: pointer;
+      margin: 0 5px;
+      padding: 0;
+      vertical-align: top;
+
+      border: 1px solid #ccc;
+      &:hover {
+        border: 1px solid red;
+      }
+
+      img {
+        max-width: 98px;
+        max-height: 98px;
+      }
+    }
+  }
+}
+
+.insert-file {
+  ul.uploaded-files {
+    margin: 5px;
+    margin-bottom: 15px;
+
+    li {
+      cursor: pointer;
+
+      &:hover {
+        text-decoration: underline;
+      }
+    }
+  }
+}
+
+table.uploaded-files {
+  img {
+    max-width: 100px;
+    max-height: 100px;
+  }
+}

data/app/assets/stylesheets/railswiki/users.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/controllers/railswiki/application_controller.rb

@@ -0,0 +1,126 @@
+module Railswiki
+  class ApplicationController < ActionController::Base
+    include ApplicationHelper
+
+    class InvalidRoleError < StandardError; end
+
+    protect_from_forgery with: :exception
+
+    helper_method :current_user, :user_can?, :prettify_title, :unprettify_title, :wiki_path
+
+    private
+
+    def current_user
+      @current_user ||= Railswiki::User.where(id: session[:user_id]).first if session[:user_id]
+    end
+
+    def user_can?(role)
+      case role
+      when :list_pages
+        true
+      when :special_pages
+        current_user
+      when :edit_page, :delete_page, :create_page, :list_pages, :history_page
+        current_user && ["admin", "editor"].include?(current_user.role)
+      when :list_users
+        current_user && ["admin", "editor"].include?(current_user.role)
+      when :edit_user, :delete_user
+        current_user && ["admin"].include?(current_user.role)
+      when :list_histories, :delete_history
+        current_user && ["admin", "editor"].include?(current_user.role)
+      when :see_page_author
+        current_user && ["admin", "editor"].include?(current_user.role)
+      when :edit_file, :delete_file, :create_file, :list_files
+        current_user && ["admin", "editor"].include?(current_user.role)
+      when :list_invites
+        current_user && ["admin", "editor"].include?(current_user.role)
+      when :delete_invite, :create_invite
+        current_user && ["admin"].include?(current_user.role)
+      else
+        raise InvalidRoleError, "Unknown role #{role}"
+      end
+    end
+
+    def require_pages_list_permission
+      require_role :list_pages
+    end
+
+    def require_special_pages_permission
+      require_role :special_pages
+    end
+
+    def require_page_edit_permission
+      require_role :edit_page
+    end
+
+    def require_page_create_permission
+      require_role :create_page
+    end
+
+    def require_page_delete_permission
+      require_role :delete_page
+    end
+
+    def require_page_history_permission
+      require_role :history_page
+    end
+
+    def require_users_list_permission
+      require_role :list_users
+    end
+
+    def require_user_edit_permission
+      require_role :edit_user
+    end
+
+    def require_user_delete_permission
+      require_role :delete_user
+    end
+
+    def require_histories_list_permission
+      require_role :list_histories
+    end
+
+    def require_history_delete_permission
+      require_role :delete_history
+    end
+
+    def require_files_list_permission
+      require_role :list_files
+    end
+
+    def require_file_edit_permission
+      require_role :edit_file
+    end
+
+    def require_file_create_permission
+      require_role :create_file
+    end
+
+    def require_file_delete_permission
+      require_role :delete_file
+    end
+
+    def require_invites_list_permission
+      require_role :list_invites
+    end
+
+    def require_invite_create_permission
+      require_role :create_invite
+    end
+
+    def require_invite_delete_permission
+      require_role :delete_invite
+    end
+
+    def require_role(role)
+      begin
+        unless user_can?(role)
+          raise InvalidRoleError, "You must be logged in to access this section"
+        end
+      rescue InvalidRoleError => e
+        redirect_to sessions_not_authorized_path
+      end
+    end
+  end
+end