RubyGems - ecrire - Versions diffs - 0.20.0 - Mend

ecrire 0.20.0

Files changed (233) hide show

data/lib/ecrire/template/assets/stylesheets/code.css.scss ADDED Viewed

@@ -0,0 +1,24 @@
+div.file.preview {
+  @include display(flex);
+  @include flex-direction(column);
+  background: #FEFEFE;
+  box-shadow: 0 0 2px 0 #AAA;
+  pre {
+    background: none;
+    box-shadow: none;
+  }
+  p {
+    margin: 0;
+    padding: 1em;
+    background: rgb(242, 239, 232);
+    border-bottom: 1px solid #CDCBC8;
+    text-align: center;
+    word-break: break-all;
+  }
+}
+pre {
+  background: #FEFEFE;
+  box-shadow: 0 0 2px 0 #AAA;
+}

data/lib/ecrire/template/assets/stylesheets/footer.css.scss ADDED Viewed

@@ -0,0 +1,5 @@
+footer {
+  a {
+    text-decoration: none;
+  }
+}

data/lib/ecrire/template/assets/stylesheets/header.css.scss ADDED Viewed

@@ -0,0 +1,18 @@
+main > header {
+  @include display(flex);
+  @include align-items(center);
+  @include justify-content(space-between);
+  padding: 2em 1em;
+  h1 {
+    font-family: courier;
+  }
+  nav {
+    a {
+      margin: 0 1em;
+      font-size: 0.8em;
+    }
+  }
+}

data/lib/ecrire/template/assets/stylesheets/home.css.scss ADDED Viewed

@@ -0,0 +1,35 @@
+main > article {
+  time {
+    font-size: 0.8em;
+    text-transform: uppercase;
+  }
+  ol.posts {
+    @include display(flex);
+    @include flex-direction(column);
+    li {
+      @include display(flex);
+      @include flex-direction(column);
+      margin-bottom: 1em;
+      h2 {
+        margin-bottom: 0;
+      }
+    }
+    div.content {
+      margin: 1em 0;
+      font-size: 1.1em;
+    }
+  }
+  div.posts.empty {
+    @include display(flex);
+    @include flex-direction(column);
+    @include align-items(center);
+    @include justify-content(center);
+  }
+}

data/lib/ecrire/template/config.ru ADDED Viewed

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+require 'ecrire'
+run Ecrire::Application.initialize!

data/lib/ecrire/template/controllers/posts_controller.rb ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ class PostsController < Ecrire::PostsController
2	+ end

data/lib/ecrire/template/helpers/blog_helper.rb ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ module BlogHelper
2	+ end

data/lib/ecrire/template/views/layouts/application.html.erb ADDED Viewed

@@ -0,0 +1,35 @@
+<!doctype html>
+<html>
+  <head>
+    <%= title_tag %>
+    <%= assets_tags %>
+    <%= meta_informations_tags %>
+  </head>
+  <%= body_tag do %>
+    <main>
+      <%= admin_navigation %>
+      <header>
+        <h1><%= link_to 'E', :root %></h1>
+        <nav>
+          <%= link_to 'Customize', '/customize' %>
+          <% if !signed_in? %>
+            <%= link_to 'Log in', new_session_path %>
+          <% end %>
+        </nav>
+      </header>
+      <article>
+        <%= yield %>
+      </article>
+      <footer>
+      </footer>
+    </main>
+  <% end %>
+</html>

data/lib/ecrire/template/views/posts/_post.html.erb ADDED Viewed

@@ -0,0 +1,9 @@
+<li class="post">
+  <%= content_tag :h2, link_to(post.title, post_path(post)) %>
+  <%= content_tag :time, l(post.published_at.to_date, format: :long) %>
+  <div class='content'>
+    <%= post.excerpt %>
+  </div>
+  <%= link_to 'Read more', post_path(post), class: %w(read) %>
+</li>

data/lib/ecrire/template/views/posts/index.html.erb ADDED Viewed

@@ -0,0 +1,13 @@
+<% if posts.any? %>
+  <ol class='posts'>
+    <%= render posts %>
+    <%= paginate posts %>
+  </ol>
+<% else %>
+  <div class='posts empty'>
+    <p>You haven't published yet.</p>
+    <% if signed_in? %>
+      <%= link_to 'Create a new post', new_title_admin_posts_path %>
+    <% end %>
+  </div>
+<% end %>

data/lib/ecrire/template/views/posts/show.html.erb ADDED Viewed

@@ -0,0 +1,7 @@
+<%= content_tag :h2, post.title %>
+<%= content_tag :time, l(post.published_at.to_date, format: :long) %>
+<div class="content">
+  <%= @post.content.html_safe %>
+</div>

data/lib/ecrire/template/views/static/about.html ADDED Viewed

File without changes

data/lib/ecrire/template/views/static/customize/_helper.html ADDED Viewed

@@ -0,0 +1,7 @@
+module YourHelper
+  def tags_list
+    Post.all.pluck(&:tags).uniq!.map do |tag|
+      link_to posts_path(tag: tag)
+    end
+  end
+end

data/lib/ecrire/template/views/static/customize/_helper_used.html ADDED Viewed

@@ -0,0 +1,6 @@
+<aside>
+  <h2>Tags</h2>
+  <p>
+    <%= '<'.html_safe %>%= tags_list %>
+  </p>
+</aside>

data/lib/ecrire/template/views/static/customize/_image.html ADDED Viewed

	@@ -0,0 +1 @@
1	+ <%= '<'.html_safe %>%= image_tag 'header.png' %>

data/lib/ecrire/template/views/static/customize/_index.html ADDED Viewed

	@@ -0,0 +1 @@
1	+ <%= '<'.html_safe %>%= render posts %>

data/lib/ecrire/template/views/static/customize/_javascript.html ADDED Viewed

	@@ -0,0 +1 @@
1	+ #= require 'file'

data/lib/ecrire/template/views/static/customize/_layout.html.erb ADDED Viewed

@@ -0,0 +1,15 @@
+<!doctype html>
+<html>
+  <head>
+    <%= '<'.html_safe %>%= title_tag %>
+    <%= '<'.html_safe %>%= assets_tags %>
+    <%= '<'.html_safe %>%= meta_informations_tags %>
+  </head>
+  <%= '<'.html_safe %>%= body_tag id: [controller_name, action_name].join('-') do %>
+    <%= '<'.html_safe %>%= admin_navigation %>
+    <%= '<'.html_safe %>%= yield %>
+  <%= '<'.html_safe %>% end %>
+</html>

data/lib/ecrire/template/views/static/customize/_post.html ADDED Viewed

@@ -0,0 +1,3 @@
+<%= '<'.html_safe %>%= posts.each do |post| %>
+  <%= '<'.html_safe %>%= link_to post.title, post_path(post) %>
+<%= '<'.html_safe %>% end %>

data/lib/ecrire/template/views/static/customize.html ADDED Viewed

@@ -0,0 +1,95 @@
+<section>
+  <h2>Customize your blog</h2>
+  <p>Ecrire generated a vanilla template for your blog. Everything you see in the folder is for you to modify. As you'll see below, there's already a lot that Ecrire comes with to help you make your blog yours.</p>
+  <p>Many of the features that are displayed here come directly from <a href="http://rubyonrails.org/">Ruby on Rails</a>. This is because Ecrire is built on top of it. That means that if you are already a user of Rails, you know <em>almost</em> everything there is to know about customizing your blog.</p>
+</section>
+<section class='customize'>
+  <h2>Views</h2>
+  <p>Views are where the HTML is built. It is built arount the concept of layout, views and partials. The three elements are nested together to create the HTML that will be sent to the browser &mdash; like this page.</p>
+  <h3>The layout</h3>
+  <p>The layout is where you put everything that is reused on <strong>every</strong> page. The layout is where you set the document type, the &lt;head&gt; element and everything else that you want to have on every page.</p>
+  <div class='file preview'>
+    <p><%= Rails.root %>/views/layouts/application.html.erb</p>
+  <pre><code class='language-ruby'><%= render('static/customize/layout').to_str %></code></pre>
+</div>
+  <p>One thing you <strong>must</strong> have in your layout is the <code class='language-ruby'>&lt;%= yield %&gt;</code> call. This call will inject the view into the layout. If you want to learn more about the layout, Ruby on rails has a <a href="http://guides.rubyonrails.org/layouts_and_rendering.html#understanding-yield">great guide that explains</a> the layout more thoroughly.</p>
+  <h3>Views</h3>
+  <p>The post views is where you can customize your HTML dependant of the URL access. Initially, there's two views configured: <code>posts/index.html.erb</code> and <code>posts/show.html.erb</code></p>
+  <p>This view is the home page of your blog. If you want to list your post entries, you can do it by adding this code snippet to your view:</p>
+  <div class='file preview'>
+    <p><%= Rails.root %>/views/posts/index.html.erb</p>
+    <pre><code class='language-ruby'><%= render('static/customize/index').to_str %></code></pre>
+  </div>
+  <p>And then add more HTML through a the partial.</p>
+  <div class='file preview'>
+    <p><%= Rails.root %>/views/posts/_post.html.erb</p>
+    <pre><code class='language-ruby'><%= render('static/customize/post').to_str %></code></pre>
+  </div>
+</section>
+<section class='customize'>
+  <h2>Helpers</h2>
+  <p>Helpers are modules you can create to define methods that can be used for different purposes.</p>
+  <div class='file preview'>
+    <p><%= Rails.root %>/helpers/your_helper.rb</p>
+    <pre><code class='language-ruby'><%= render('static/customize/helper').to_str %></code></pre>
+  </div>
+  <p>It is automatically available in your views.</p>
+  <div class='file preview'>
+    <p><%= Rails.root %>/helpers/your_helper.rb</p>
+    <pre><code class='language-html'><%= render('static/customize/helper_used').to_str %></code></pre>
+  </div>
+</section>
+<section class='customize'>
+  <h2>Assets</h2>
+  <p>The assets are the CSS, JS and any images you would like to show on your blog that aren't a part of a blog post. Ecrire &mdash; via Rails &mdash; provides a few mechanism to help you build customize your theme.</p>
+  <p>Everything that is described here can be found in use within your default theme. Just browse the code to see an example of what is documented here.</p>
+  <h3>Stylesheets</h3>
+  <p>Stylesheets can either be pure CSS or <a href='http://sass-lang.com/'>SASS</a>. Rails will use the SASS preprocessor if the file ends with .scss.</p>
+  <p>You will notice a file name base.css.scss with a few @import rules. These rules are necessary if you want to include other files besides the <em>required</em> base.css. Since it supports wildcard, you don't need to specify every file in your folder.</p>
+  <p>You can also add libraries that are available as gem. By default, Ecrire comes with <a href='http://bourbon.io/'>Bourbon</a>, which is imported by default. That means you can have access to all the bourbon mixins from <strong>any</strong> stylesheet.</p>
+  <h3>Javascripts</h3>
+  <p>Javascripts can either be pure Javascript or Coffeescript.</p>
+  <p>If you choose to use Coffeescript, you only need to append .coffee to your file to enable the pre-compiler. Similar to your stylesheets, javascript has an import rule. While the @import rule is specified within the <a href='https://developer.mozilla.org/en/docs/Web/CSS/@import'>CSS Standard</a>, ECMAScript doesn't have such a thing.</p>
+  <p>Sprockets uses a directive through commenting the top of the file. It uses a similar syntax it shouldn't be too hard to make modification. Also, there's an example from within this theme.</p>
+  <div class='file preview'>
+    <p><%= Rails.root %>/assets/javascripts/base.js.coffee</p>
+    <pre><code class='language-coffeescript'><%= render('static/customize/javascript').to_str %></code></pre>
+  </div>
+  <p>Note that if you want to use vanilla javascript, you will need to use the commenting syntax for javascript (//=).</p>
+  <h3>Images</h3>
+  <p>Images can be any format that are supported by the browser. However, you need to use a helper when you use images that you put in the assets/images folder.</p>
+  <div class='file preview'>
+    <p><%= Rails.root %>/assets/images/header.png</p>
+    <pre><code class='language-coffeescript'><%= render('static/customize/image').to_str %></code></pre>
+  </div>
+</section>

data/lib/ecrire/version.rb ADDED Viewed

@@ -0,0 +1,3 @@
+module Ecrire
+  VERSION = '0.20.0'
+end

data/lib/ecrire.rb ADDED Viewed

@@ -0,0 +1,24 @@
+module Ecrire
+  autoload :Application,        'ecrire/application'
+  def self.bundle?
+    ENV['BUNDLE_GEMFILE'] ||= Dir.pwd + '/Gemfile'
+    File.exists?(ENV['BUNDLE_GEMFILE'])
+  end
+  if Ecrire.bundle?
+    require 'bundler/setup'
+    require 'rails/all'
+    require 'bourbon'
+    require 'sass-rails'
+    require 'sprockets'
+    require 'coffee-rails'
+    require 'turbolinks'
+    Bundler.require(:required, :server, Rails.env)
+  else
+    require 'rails/all'
+  end
+end

data/test/editor/controllers/admin/images_controller_test.rb ADDED Viewed

@@ -0,0 +1,6 @@
+require_relative '../base_controller_test'
+module Admin
+  class ImagesControllerTest < BaseControllerTest
+  end
+end

data/test/editor/controllers/admin/posts_controller_test.rb ADDED Viewed

@@ -0,0 +1,90 @@
+module Admin
+  class PostsControllerTest < BaseControllerTest
+    def setup
+      super
+      proxy.set_user users(:pothibo)
+    end
+    test 'Validations: Error should be shown when missing the title' do
+    end
+    test 'Create a post' do
+      data = {
+        title: 'A new published post',
+        content: 'Some Blah blah',
+        stylesheet: 'h1 {\n  text-align: center;\n }'
+      }
+      put :create, post: data
+      @post = assigns(:post)
+      assert_equal data[:title], @post.title
+      assert_equal data[:content], @post.content
+      assert_equal data[:stylesheet], @post.stylesheet
+      assert_equal data[:title].parameterize, @post.slug
+    end
+    test 'Update a post' do
+      data = {
+        title: 'A new published post',
+        content: 'Some Blah blah',
+        stylesheet: 'h1 {\n  text-align: center;\n }'
+      }
+      put :update, id: posts(:published).id, post: data
+      @post = assigns(:post)
+      assert_equal data[:title], @post.title
+      assert_equal data[:content], @post.content
+      assert_equal data[:stylesheet], @post.stylesheet
+      assert_equal posts(:published).slug, @post.slug
+      data[:slug] = ""
+      put :update, id: posts(:published).id, post: data
+      @post = assigns(:post)
+      assert_equal data[:title], @post.title
+      assert_equal data[:content], @post.content
+      assert_equal data[:stylesheet], @post.stylesheet
+      assert_equal @post.title.parameterize, @post.slug
+    end
+    test 'Saving a post should redirect to keep editing the post' do
+      post :create, post: {'title' => 'Just a test'}
+      record = assigns(:post)
+      assert_redirected_to edit_admin_post_path(record.id)
+      put :update, id: record.id, post: {'content' => 'Something to say'}
+      assert_redirected_to edit_admin_post_path(record.id)
+    end
+    test 'Saving a published article should redirect to the post edit' do
+      @post = posts(:published)
+      put :update, id: @post.id, post: {'content' => 'Oh em G'}
+      assert_redirected_to edit_admin_post_path(@post.id)
+    end
+    test 'Publishing redirects to the blog post' do
+      data = {
+        title: 'A new published post',
+        content: 'Some Blah blah',
+        stylesheet: 'h1 {\n  text-align: center;\n }'
+      }
+      put :update, id: posts(:published).id, post: data, button: 'publish'
+      assert assigns(:post).published?
+      assert_redirected_to post_path(assigns(:post).published_at.year, assigns(:post).published_at.month, assigns(:post).slug)
+    end
+    test 'Show draft posts' do
+      xhr :get, :index
+      assigns(:posts).each do |post|
+        assert !post.published?
+      end
+    end
+  end
+end

data/test/editor/controllers/base_controller_test.rb ADDED Viewed

@@ -0,0 +1,26 @@
+require 'editor/test_helper'
+class BaseControllerTest < ActionController::TestCase
+  include Warden::Test::Helpers
+  def self.manager
+    @manager ||= Warden::Manager.new(self,
+      {
+        default_strategies: :password,
+        failure_app: SessionsController.action(:failed)
+      })
+  end
+  def setup
+    @controller.env['warden'] = @request.env['warden'] = Warden::Proxy.new(@request.env, self.class.manager)
+  end
+  def teardown
+    Warden.test_reset!
+  end
+  def proxy
+    @controller.env['warden']
+  end
+end

data/test/editor/controllers/images_controller_test.rb ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ class ImagesControllerTest < BaseControllerTest
2	+ end

data/test/editor/controllers/partials_controller_test.rb ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ class PartialsControllerTest < BaseControllerTest
2	+ end

data/test/editor/controllers/posts_controller_test.rb ADDED Viewed

@@ -0,0 +1,21 @@
+class PostsControllerTest < BaseControllerTest
+  test "redirect if the post isn't published" do
+    @post = posts(:draft)
+    get :show, year: 2003, month: 1, id: @post.id
+    assert_redirected_to :root
+  end
+  test "redirect if the post doesn't exist" do
+    get :show, year: 2003, month: 1, id: -1
+    assert_redirected_to :root
+  end
+  test 'Only published posts should be listed in the index' do
+    get :index
+    posts.each do |post|
+      assert post.published?
+    end
+  end
+end

data/test/editor/controllers/sessions_controller_test.rb ADDED Viewed

@@ -0,0 +1,21 @@
+class SessionsControllerTest < BaseControllerTest
+  test 'should be able to log in' do
+    post :create, session: {email: "pothibo@gmail.com", password: "123456789"}
+    assert !proxy.user.nil?, "#{users(:pothibo).email} should be logged in"
+    assert_redirected_to root_path
+  end
+  # From what I could read, functional tests do not play nice with middlewares.
+  # So, because I can't rely on Warden::Manager to catch the thrown error here, I
+  # have 2 options: Move to integration testing or work around the issue.
+  # I chose the later for now but I believe that it might be a good idea to move controller
+  # testing to actual integration tests. Most of the work is done on the UI anyway so it would
+  # cover every cases.
+  test 'show and error if your credentials do not satisfy' do
+    catch :warden do
+      post :create, session: {email: "pothibo@gmail.com", password: "ksjaslk"}
+    end
+    assert proxy.user.nil?, "#{users(:pothibo).email} should NOT be logged in"
+  end
+end

data/test/editor/helpers/base_helper_test.rb ADDED Viewed

@@ -0,0 +1,19 @@
+class BaseHelperTest < ActionView::TestCase
+  include Rails.application.routes.url_helpers
+  def signed_in?
+    !@user.nil?
+  end
+  def current_user
+    @user
+  end
+  protected
+  def sign_user_in!
+    @user = User.allocate
+  end
+end

data/test/editor/helpers/posts_helper_test.rb ADDED Viewed

@@ -0,0 +1,3 @@
+class PostsHelperTest < BaseHelperTest
+end

data/test/editor/models/image_test.rb ADDED Viewed

@@ -0,0 +1,33 @@
+require 'editor/test_helper'
+class ImageTest < ActiveSupport::TestCase
+  Struct.new('File', :original_filename)
+  test 'should only return favorited images' do
+    Image.favorites.each do |image|
+      assert image.favorite?, 'Image should be favorited'
+    end
+  end
+  test 'path should handle blank base_folder' do
+    Rails.application.secrets.s3['path'] = ""
+    file = Struct::File.new('some_image.jpg')
+    image = Admin::Image.new
+    image.post = Admin::Post.first
+    assert_equal image.send(:path, file), "#{image.post.id}/some_image.jpg"
+  end
+  test 'path should handle base_folder' do
+    Rails.application.secrets.s3['path'] = "my_blog"
+    file = Struct::File.new('some_image.jpg')
+    image = Admin::Image.new
+    image.post = Admin::Post.first
+    assert_equal image.send(:path, file), "my_blog/#{image.post.id}/some_image.jpg"
+  end
+end

data/test/editor/models/partial_test.rb ADDED Viewed

@@ -0,0 +1,4 @@
+require 'editor/test_helper'
+class PartialTest < ActiveSupport::TestCase
+end