nocms 0.2.0 → 0.3.0

data/README.rdoc

@@ -1,22 +1,36 @@
 = NOCMS
 
-NOCMS is a web service that allows you to add basic Content Management to any website.  
-It provides wiki-style editing with a few lines of Javascript, and server-side rendering 
-and user authentication support with just some simple server-side integration.
+NOCMS is a web service that allows you to add basic WYSIWYG Content Management to any website.  
+It provides wiki-style editing with a few lines of Javascript.  Add just a few lines more to
+your application and you get server-side rendering and 'editor' authentication.
 
-If you've ever been involved in hand-to-hand combat with a big, ugly, hard to customize 
-Content Management System (CMS), then NOCMS might be right for you.
+The NOCMS gem provides server-side integration with api.nocms.org for ruby applications built on the Rails or Sinatra frameworks.
+
+NOCMS is for you if:
+* You want to add WYSIWYG editing to an existing static website
+* Wordpress, Drupal and similar OSS Content Management Systems are too much for your needs
+* You want to add basic CMS functions to your existing web app
+
+FEATURES (NOCMS RUBY GEM)
+* Wiki-style WYSIWYG editing with just 3 lines of Javascript
+* Server-side rendering of content for SEO purposes and improved performance
+* Caching via native Rails.cache or a custom Sinatra cache (Hash)
+* nocms_block() view helper for adding editable blocks to your pages/views
 
 Website: http://www.nocms.org
 Mailing List: http://groups.google.com/group/nocms
 Twitter: http://twitter.com/powcloud
 
 == Changes
-
+* 0.3.0 
+  * FEA: Add path_has_content? which returns true if the given path has content in the cache in either the current language or the default language
+* 0.2.1
+  * BUG: Fix a serialization bug for the keys list, now using Sets
 * 0.2.0 
-  * Added Rails support incl. caching
-  * First stab at unit tests
-* 0.1.0 First prototype of the ruby gem - Sinatra support
+  * FEA: Added Rails support incl. caching
+  * FEA: First stab at unit tests
+* 0.1.0 
+  * FEA: First prototype of the ruby gem - Sinatra support
 
 
 == Note on Patches/Pull Requests

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/lib/nocms.rb

@@ -2,9 +2,7 @@ require 'active_support'
 require 'net/http'
 require 'uri'
 require 'cgi'
- 
-
-# This is a default, that might be override by the app
+require 'set'
 
 module NoCMS
   class Cache < Hash   
@@ -24,7 +22,6 @@ module NoCMS
       
       NoCMS::Base.lang_default = 'en'
       
-      #@@nocms_lang_default = 'en'
       @@nocms_cache = NoCMS::Cache.new
 
       def environment
@@ -37,14 +34,9 @@ module NoCMS
       end
     
       def diagnostic
-        buffer = ''
-        buffer += "NoCMS Diagnostics\n"
+        buffer = "NoCMS Diagnostics\n"
         buffer += "  Rails: #{rails?}\n"
-        if rails?
-          buffer += "    Cache Store: #{ActionController::Base.cache_store}\n"
-          buffer += "    Cache (Object): #{Rails.cache}\n"
-        end
-
+        buffer += "\tCache Store: #{ActionController::Base.cache_store}\n\tCache (Object): #{Rails.cache}\n" if rails?
         buffer += "  Cache: #{cache.class}\n"
         buffer += "  Environment: #{environment}\n"
         buffer += "  Site Key: #{site}\n"
@@ -66,6 +58,21 @@ module NoCMS
         load_cache if updated_at.nil? || updated_at < Time.now - 5*60  
       end
       
+      def path_has_content?(request, path = nil, options = {})
+        path ||= options.delete(:path) || request.path || request.path_info
+        
+        ensure_cache()
+        
+        lang = options.delete(:lang) || request.env['HTTP_ACCEPT_LANGUAGE'].nil? ? nil : request.env['HTTP_ACCEPT_LANGUAGE'].scan(/^[a-z]{2}/).first || 'en'
+        lang_default = NoCMS::Base.lang_default
+
+        tmp = cache.read("NOCMS:#{site}:paths")
+        paths = !tmp.nil? ? Set.new(ActiveSupport::JSON.decode(tmp)) : Set.new
+
+        return paths.include? "/#{lang}#{path}" if lang==lang_default
+        paths.include?("/#{lang}#{path}") || paths.include?("/#{lang_default}#{path}")
+      end
+      
       def load_cache
         start_time = Time.now
         raise '[NOCMS] Must specify a site' if NoCMS::Base.site.nil?
@@ -74,22 +81,28 @@ module NoCMS
         
         # save this for a bit
         tmp = cache.read("NOCMS:#{site}:keys")
-        old_keys = !tmp.nil? ? ActiveSupport::JSON.decode(tmp) : {}
+        old_keys = !tmp.nil? ? Set.new(ActiveSupport::JSON.decode(tmp)) : Set.new
         
         # load the new stuff
         rq = "http://api.nocms.org/nocms/1.0/export?site=#{site}"
         json = Net::HTTP.get(URI.parse(rq))  
         new_blocks = ActiveSupport::JSON.decode(json)
-        #Rails.cache["NOCMS:#{site}:json"] = json
-        cache.write("NOCMS:#{site}:keys", new_blocks.collect {|block| build_key(block['block']['path'], block['block']['xpath'])} )
+        
+        keys = Set.new
+        paths = Set.new 
+        
          # add new keys and update existing
         new_blocks.each do |block|
           p = block['block']
-          #@@nocms_pages["#{p['path']}:#{p['xpath']}"] = p['content']
           key = build_key(p['path'], p['xpath'])
+          keys << key
+          paths << p['path']
           cache.write(key,  p['content'])
           old_keys.delete(key)
         end
+
+        cache.write("NOCMS:#{site}:paths", ActiveSupport::JSON.encode(paths))
+        cache.write("NOCMS:#{site}:keys", ActiveSupport::JSON.encode(keys))
         
         # purge keys that have been deleted
         old_keys.each {|key| cache.delete(key)}
@@ -103,41 +116,38 @@ module NoCMS
       def can_edit?()
         environment != :production
       end
-            
     end
-  
   end
-
 end
 
-#module ActionView
-#  class Base
-
-#    def nocms_block2(id, options = {})
-#      "NOCMS WAS HERE!"
-#    end
-#  end
-#end
+def path_has_content?(path=nil, options={})
+  NoCMS::Base.path_has_content?(request,path,options)
+end
 
+def nocms_block(id, options = {})
 
+  tag  = options.delete(:tag)  || 'div'
+  site = options.delete(:site) || NoCMS::Base.site    # ||= request.host_with_port
+  path = options.delete(:path) || request.path || request.path_info
+  lang = options.delete(:lang) || request.env['HTTP_ACCEPT_LANGUAGE'].nil? ? nil : request.env['HTTP_ACCEPT_LANGUAGE'].scan(/^[a-z]{2}/).first || 'en'
+  lang_default = NoCMS::Base.lang_default
 
-def nocms_block(id, options = {})
   raise 'Must specify an element id as the first parameter. :tag and :content are optional params' if id.nil?
-  
-  #request = ActionController::Base.request ||= Sinatra::Base.request
-  
-  tag = options[:tag] ||= 'div'
-  site = options[:site] ||= NoCMS::Base.site    # ||= request.host_with_port
-  path = options[:path] ||= request.path ||= request.path_info
-  lang = options[:lang] ||= request.env['HTTP_ACCEPT_LANGUAGE'].nil? ? nil : request.env['HTTP_ACCEPT_LANGUAGE'].scan(/^[a-z]{2}/).first ||= 'en'
-  lang_default = NoCMS::Base.lang_default
+  raise 'Path could not be determined, pass :path and ensure it is not nil' if path.nil?
+  raise 'Site could not be determined.  Please set the NoCMS site variable per the documentation' if site.nil?  
   
   NoCMS::Base.ensure_cache()
   
-  ## TODO: exception throw when these are consolidated????
-  content = NoCMS::Base.cache.read(NoCMS::Base.build_key("/#{lang}#{path}", id))
-  content = content ||= NoCMS::Base.cache.read(NoCMS::Base.build_key("/#{lang_default}#{path}", id)) if lang != lang_default
-  content = content ||= options[:default] ||= 'Lorem ipsum'
+  content = NoCMS::Base.cache.read(NoCMS::Base.build_key("/#{lang}#{path}", id)) 
+  content ||= NoCMS::Base.cache.read(NoCMS::Base.build_key("/#{lang_default}#{path}", id)) if lang != lang_default 
+  content ||= options.delete(:default) || 'Lorem ipsum'
+  
+  attr_class = ['nocms_edit']
+  add_classes = options.delete(:class)
+  attr_class += add_classes.split(' ') if !add_classes.nil?
+ 
+  attributes = options.collect { |k,v| "#{k}='#{v}'" } if options.length > 0
       
-  "<#{tag} id='#{id}' class='nocms_edit'>#{content}</#{tag}>"
-end
+  "<#{tag} id='#{id}' #{attributes} class='#{attr_class.join(" ").strip}'>#{content}</#{tag}>"
+end
+

data/nocms.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{nocms}
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Darren Rush"]
-  s.date = %q{2010-08-20}
+  s.date = %q{2010-08-23}
   s.description = %q{A Ruby client for the NOCMS.org web service API.  Provides server-side helpers for Rails/Sinatra/Rack applications. keywords: ruby, rails, sinatra, rack, CMS, content management systems, search, cloud, SAAS, JSON, web service}
   s.email = %q{nocms@powcloud.com}
   s.extra_rdoc_files = [

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: nocms
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: false
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Darren Rush
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-20 00:00:00 -07:00
+date: 2010-08-23 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency