nanoc-polly 0.0.1.pre1 → 0.0.2

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*/public/

data/README.md

@@ -1,53 +1,79 @@
 # Nanoc::Polly
 
-Integrates Pollypost with nanoc.
+## Integrate Pollypost with nanoc!
+
+This Ruby Gem provides a backend for [Pollypost](https://github.com/pollypost/pollypost), so you can use browser based inline editing on static sites generated with [nanoc](http://nanoc.ws/).
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Install nanoc-polly yourself as:
+
+    $ gem install nanoc-polly
+
+Or, if you're using [Bundler](http://bundler.io/), add this line to your application's Gemfile:
+
+```ruby
+gem 'nanoc-polly'
+```
+
+And then execute:
+
+    $ bundle install
+
+### Development version
+
+In case you want to use the most up-to-date development version, add this GitHub path to your Gemfile:
 
 ```ruby
 gem 'nanoc-polly', :github => 'pollypost/nanoc-polly'
 ```
-or, if you downloaded the source files to your local file system
+or, if you cloned the source files to your local file system:
 
 ```ruby
 gem 'nanoc-polly', :path => './path_to/nanoc-polly'
 ```
 
-And then execute:
-
-    $ bundle
+### Polly Helper
 
-Or download the pkg/nanoc-polly.gem and install it yourself as:
+Nanoc-polly comes with a predefined helper that adds functionality for generating the 'about' tags needed for Pollypost. See [Pollypost](https://github.com/pollypost/pollypost) for details.
 
-    $ gem install nanoc-polly.gem
+To activate the helper, add this line to a file in your `lib` folder:
 
-In your nanoc.yaml, add the location of the compiled Pollypost assets folder, e.g.
 ```ruby
-polly:
-  assets_location: 'pollypost/public/assets'
+include Nanoc::Helpers::Polly
+```
+
+You can then generate a file's 'about' value with `item_about @item`:
+
+```html
+<div class="edit-this" about="<%= item_about @item %>">
+  <%= yield %>
+</div>
 ```
 
 ## Usage
 
-To enable Pollypost on your site, just start the nanoc weserver with
+To enable Pollypost on your site, just start the nanoc webserver with
 
     $ nanoc edit -a
 
-This behaves very similar to `nanoc view` but adds all the components needed for Pollypost. The -a Option loads all the assets shipped with Pollypost, without it you'd have to make sure yourself that the files are found on the specified path.
+This behaves very similar to `nanoc view` but adds all the components needed for Pollypost. The `-a` Option loads all the assets shipped with Pollypost, without it you'd have to make sure yourself that the files are found on the specified path (see Config Options).
+
+Your site is available at `localhost:3000`.
+
+For additional options try `nanoc edit --help`.
 
 ## Config Options
 
-In your nanoc.yaml file you can set the following configuration options:
+In your nanoc.yaml file you can set the following configuration options for Pollypost (shown here are their default values):
 
 ```ruby
 polly:
-  assets_location: 'nocms/pollypost/public/assets'
-  assets_path_prefix: '/polly/assets/'
-  backend_path_prefix: '/polly/'
-  image_storage: uploadcare
-  uploadcare_api_key: 82f609e341c7fe23fcc6
+  assets_location: 'public/polly'       # folder where the compiled Pollypost assets are stored
+  assets_path_prefix: '/polly/assets/'  # url prefix for Pollypost asset paths
+  backend_path_prefix: '/polly/'        # url prefix for Pollypost backend paths
+  image_storage: ''                     # which image storage to use (e.g. 'uploadcare')
+  uploadcare_api_key: ''                # api key if you are using uploadcare as image storage
 ```
 
 ## Contributing
@@ -58,3 +84,13 @@ polly:
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
 
+
+## License
+
+Copyright (C) 2015 [more onion](https://www.more-onion.com)
+
+Pollypost is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+
+Pollypost is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License (LICENSE.md) along with this program. If not, see <http://www.gnu.org/licenses/>.

data/Rakefile

@@ -1,3 +1,2 @@
 require "bundler/gem_tasks"
-require "pollypost/asset_tasks"
 

data/lib/nanoc-edit.rb

@@ -22,12 +22,20 @@ option :i, :host, 'host to use (default: 0.0.0.0)', :argument => :optional
 
 module Nanoc::CLI::Commands
   class Edit < ::Nanoc::CLI::CommandRunner
+    DEFAULT_DATA_SOURCE_INDEX = 0
     DEFAULT_HANDLER_NAME = :thin
     DEFAULT_BACKEND_PATH_PREFIX = '/polly/'
     DEFAULT_ASSETS_PATH_PREFIX = '/polly/assets/'
+    DEFAULT_ASSETS_LOCATION = 'public/polly/'
 
     def run
-      require_site
+      # require_site
+      site = nil
+      if Nanoc::Site.cwd_is_nanoc_site?
+        site = Nanoc::Site.new('.')
+      else
+        raise ::Nanoc::Errors::GenericTrivial, 'The current working directory does not seem to be a nanoc site.'
+      end
 
       require 'rack'
       require 'rack/polly'
@@ -44,9 +52,11 @@ module Nanoc::CLI::Commands
         end
       end
 
+      polly_config = site.config[:polly] ? site.config[:polly] : {}
       with_assets = options[:assets] ? true : false
-      if with_assets
-        raise ArgumentError, "assets_location not configured" unless site.config[:polly][:assets_location]
+      assets_location = polly_config[:assets_location] ? polly_config[:assets_location] : DEFAULT_ASSETS_LOCATION
+      if with_assets && !File.directory?(File.expand_path(assets_location))
+        raise ArgumentError, "assets_location '#{assets_location}' is not a directory."
       end
 
       # Set options
@@ -56,32 +66,32 @@ module Nanoc::CLI::Commands
       }
 
       # Build app
-      site = self.site
       require 'nanoc/polly/backend'
 
       rack_polly_options = {}
 
       # set required options
-      backend_path_prefix = site.config[:polly][:backend_path_prefix] ? site.config[:polly][:backend_path_prefix] : DEFAULT_BACKEND_PATH_PREFIX
-      assets_path_prefix = site.config[:polly][:assets_path_prefix] ? site.config[:polly][:assets_path_prefix] : DEFAULT_ASSETS_PATH_PREFIX
+      data_source_index = polly_config[:data_source_index] ? polly_config[:data_source_index] : DEFAULT_DATA_SOURCE_INDEX
+      backend_path_prefix = polly_config[:backend_path_prefix] ? polly_config[:backend_path_prefix] : DEFAULT_BACKEND_PATH_PREFIX
+      assets_path_prefix = polly_config[:assets_path_prefix] ? polly_config[:assets_path_prefix] : DEFAULT_ASSETS_PATH_PREFIX
       rack_polly_options = rack_polly_options.merge({
         assets_path_prefix: assets_path_prefix,
         backend_path_prefix: backend_path_prefix
       })
 
       # set image storage options
-      image_storage = site.config[:polly][:image_storage] ? site.config[:polly][:image_storage] : false
+      image_storage = polly_config[:image_storage] ? polly_config[:image_storage] : false
       if image_storage && image_storage.to_s == 'uploadcare'
-        raise ArgumentError, "uploadcare_api_key not configured" unless site.config[:polly][:uploadcare_api_key]
+        raise ArgumentError, "uploadcare_api_key not configured" unless polly_config[:uploadcare_api_key]
         rack_polly_options = rack_polly_options.merge({
           image_storage: image_storage,
-          uploadcare_api_key: site.config[:polly][:uploadcare_api_key]
+          uploadcare_api_key: polly_config[:uploadcare_api_key]
         })
       end
 
       app = Rack::Builder.new do
         map assets_path_prefix do
-          run Rack::File.new(site.config[:polly][:assets_location])
+          run Rack::File.new(assets_location)
         end if with_assets
         map '/' do
           use Rack::CommonLogger
@@ -93,7 +103,8 @@ module Nanoc::CLI::Commands
           run Rack::File.new(site.config[:output_dir])
         end
         map backend_path_prefix do
-         run Nanoc::Polly::Backend.new
+          Nanoc::Polly::Config.data_source_index = data_source_index
+          run Nanoc::Polly::Backend.new
         end
       end.to_app
 

data/lib/nanoc/helpers/polly.rb

@@ -0,0 +1,21 @@
+#   Copyright (C) 2015 more onion
+#
+#   Pollypost is free software: you can use, redistribute and/or modify it
+#   under the terms of the GNU General Public License version 3 or later.
+#   See LICENCE.txt or <http://www.gnu.org/licenses/> for more details.
+
+
+module Nanoc::Helpers
+  module Polly
+    def item_about item
+      if item[:about]
+        item[:about]
+      elsif item.path == '/' # special path
+        'index'
+      else
+        # remove leading and trailing /
+        item.path.sub(/\A\//,'').sub(/\/\z/, '')
+      end
+    end
+  end
+end

data/lib/nanoc/polly.rb

@@ -7,6 +7,7 @@
 
 
 require "nanoc/polly/version"
+require "nanoc/helpers/polly"
 require 'nanoc'
 require 'nanoc/cli'
 require 'nanoc/cli/command_runner'

data/lib/nanoc/polly/backend.rb

@@ -11,6 +11,7 @@ require 'json'
 require 'nanoc'
 require 'loofah'
 require 'htmlbeautifier'
+require 'nanoc/polly/config'
 
 module Nanoc::Polly
 class Backend < Sinatra::Base
@@ -41,29 +42,18 @@ class Backend < Sinatra::Base
     end
 
     if identifier && json['content']
-      require_site
-
       # TODO find a way to not have to load the site twice in one request
-      site = Nanoc::Site.new('.')
-      data_source = Nanoc::DataSources::FilesystemUnified.new(site, '/', '/', {})
-      if site.items[identifier]
+      # assuming we are running in a nanoc site dir
+      @site = Nanoc::Site.new('.')
+      @data_source = @site.data_sources[Nanoc::Polly::Config.data_source_index]
+      if @site.items[identifier]
         return [409, {}, {
           about: identifier,
           message: "Page already exists."
         }.to_json ]
       end
 
-      sanitized_content = sanitize_content(json['content'])
-      data_source.create_item(sanitized_content, {
-        about: about,
-        title: json['title'] ? json['title'] : 'Title',
-        layout: 'default'}, identifier)
-      recompile!
-      return [ 202, {}, {
-        about: identifier,
-        message: "Page creation request accepted.",
-        content: sanitized_content
-      }.to_json ]
+      create! identifier, about, json
     else
       return [400, {}, {
         message: "Invalid request."
@@ -86,9 +76,9 @@ class Backend < Sinatra::Base
       end
       identifier = '/' + about + '/'
     end
- 
-    require_site
+
     # TODO find a way to not have to load the site twice in one request
+    # assuming we are running in a nanoc site dir
     site = Nanoc::Site.new('.')
     if site.items[identifier]
       return [200, {}, {
@@ -120,14 +110,13 @@ class Backend < Sinatra::Base
       identifier = '/' + about + '/'
     end
 
- 
-    require_site
     # TODO find a way to not have to load the site twice in one request
-    site = Nanoc::Site.new('.')
-    data_source = Nanoc::DataSources::FilesystemUnified.new(site, '/', '/', {})
+    # assuming we are running in a nanoc site dir
+    @site = Nanoc::Site.new('.')
+    @data_source = @site.data_sources[Nanoc::Polly::Config.data_source_index]
     attributes = []
     # read and use attributes from saved item
-    if item = site.items[identifier]
+    if item = @site.items[identifier]
       attributes = sanitize_attributes(item.attributes)
     else
       return [404, {}, {
@@ -136,21 +125,12 @@ class Backend < Sinatra::Base
       }.to_json ]
     end
 
+    @content_bak = item.raw_content.clone
+    @attributes_bak = item.attributes.clone
     body = request.body.read
     json = JSON.parse(body)
     if json['content']
-      sanitized_content = sanitize_content(json['content'])
-      attributes.merge!(json['attributes']) if json['attributes']
-      # make sure that about is not overriden in PUT
-      # we always want this to be the value given in the request path
-      attributes[:about] = about
-      data_source.create_item(sanitized_content, attributes, identifier)
-      recompile!
-      return [ 202, {}, {
-        about: identifier,
-        message: "Page update request accepted.",
-        content: sanitized_content
-      }.to_json ]
+      update! identifier, about, attributes, json
     else
       return [400, {}, {
         message: "Invalid request."
@@ -173,6 +153,8 @@ class Backend < Sinatra::Base
     }.to_json]
   end
 
+  protected
+
   # @TODO
   def sanitize_about about
     return about
@@ -194,13 +176,73 @@ class Backend < Sinatra::Base
 
   # TODO maybe as a nonblocking background task
   def recompile!
-    require_site
     # difficult to cache site because of nanoc internal caching (freeze)
     # TODO optimize recompilation
+    # assuming we are running in a nanoc site dir
     site = Nanoc::Site.new('.')
     site.compile
   end
 
+  def create! identifier, about, json
+    sanitized_content = sanitize_content(json['content'])
+    begin
+      @data_source.create_item(sanitized_content, {
+        about: about,
+        title: json['title'] ? json['title'] : 'Title',
+        layout: 'default'}, identifier)
+      recompile!
+    rescue Nanoc::Errors::Generic => e
+      # rollback, i.e. delete the newly created file
+      # we assume the file was created in this request as we should have
+      # passed the "page already exists" test in the post handler
+      new_items = @data_source.items.select do |item|
+        item.identifier == identifier
+      end
+      path = File.expand_path(new_items.first.raw_filename)
+      if File.file? path
+        File.delete path
+      end
+      puts "[ERR] #{e}"
+      recompile!
+      return [ 400, {}, {
+        about: identifier,
+        message: "Invalid request. #{e} Rolled back."
+      }.to_json ]
+    end
+
+    return [ 202, {}, {
+      about: identifier,
+      message: "Page creation request accepted.",
+      content: sanitized_content
+    }.to_json ]
+  end
+
+  def update! identifier, about, attributes, json
+    sanitized_content = sanitize_content(json['content'])
+    attributes.merge!(json['attributes']) if json['attributes']
+    # make sure that about is not overriden in PUT
+    # we always want this to be the value given in the request path
+    attributes[:about] = about
+    begin
+      @data_source.create_item(sanitized_content, attributes, identifier)
+      recompile!
+    rescue Nanoc::Errors::Generic => e
+      @data_source.create_item(@content_bak, @attributes_bak, identifier)
+      recompile!
+      puts "[ERR] #{e}"
+      return [ 400, {}, {
+        about: identifier,
+        message: "Invalid request. #{e} Rolled back."
+      }.to_json ]
+    end
+
+    return [ 202, {}, {
+      about: identifier,
+      message: "Page update request accepted.",
+      content: sanitized_content
+    }.to_json ]
+  end
+
   # start the server if ruby file executed directly
   run! if app_file == $0
 end

data/lib/nanoc/polly/config.rb

@@ -0,0 +1,19 @@
+#   This file is part of nanoc-polly, a nanoc backend for Pollypost.
+#   Copyright (C) 2015 more onion
+#
+#   Pollypost is free software: you can use, redistribute and/or modify it
+#   under the terms of the GNU General Public License version 3 or later.
+#   See LICENCE.txt or <http://www.gnu.org/licenses/> for more details.
+
+
+module Nanoc::Polly
+  class Config
+    class << self
+      attr_accessor :data_source_index
+    end
+
+    def self.data_source_index
+      @data_source_index || 0
+    end
+  end
+end

data/lib/nanoc/polly/version.rb

@@ -8,6 +8,6 @@
 
 module Nanoc
   module Polly
-    VERSION = "0.0.1.pre1"
+    VERSION = "0.0.2"
   end
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: nanoc-polly
 version: !ruby/object:Gem::Version
-  version: 0.0.1.pre1
-  prerelease: 6
+  version: 0.0.2
+  prerelease: 
 platform: ruby
 authors:
 - Alex Berger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-13 00:00:00.000000000 Z
+date: 2015-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nanoc
@@ -130,13 +130,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/nanoc-edit.rb
+- lib/nanoc/helpers/polly.rb
 - lib/nanoc/polly.rb
 - lib/nanoc/polly/backend.rb
+- lib/nanoc/polly/config.rb
 - lib/nanoc/polly/version.rb
 - lib/rack/polly.rb
 - nanoc-polly.gemspec
@@ -156,9 +159,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23