almost-happy 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Darcy Laycock
+
+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,78 @@
+# Almost Happy #
+
+Almost happy is a set of content management tools for ActiveRecord 3 and higher. It's built
+on a simple, clean code base that makes it easy to do trivial content management tools.
+
+## Usage ##
+
+First off, you'll need to add the gem to the Gemfile. For most cases, the following line should do:
+
+    gem "almost-happy"
+    
+Then, run `bundle install`.
+
+Currently it provides two sets of functionality - publishable and convertable.
+
+E.g. to make a model publishable:
+
+    class Page < ActiveRecord::Base
+      is_publishable
+    end
+    
+And, for each content field, declare it convertable:
+
+    class Page < ActiveRecord::Base
+      is_publishable
+      is_convertable :content
+    end
+    
+And before each save it will automatically convert the content to html
+using the specific format etc.
+
+### is\_publishable ###
+
+When a model is marked as publishable, it provides the following instance methods:
+
+* `published?` - returns a boolean indicating if it's publishe
+* `publish!` - mark the post as published right now.
+
+And, the following class methods:
+
+* `published` - returns a relation with all published posts
+* `ordered` - returns a relation ordered by the published at time
+* `ordered_for_preview` - returns a relation ordered by the published at time, those unpublished first.
+
+### is\_convertable ###
+
+When a model is marked as convertable, it adds hooks (inc. validation) to convert
+raw content in one format to another.
+
+the `is_convertable` call accepts field names as the argument and an optional options hash.
+
+The options hash currently has one options - `:validate` - defaulting to true, determining whether
+the presence and format is validated.
+
+For each field passed to `is_convertable`, it will provide the following methods:
+
+* `#{field}_as_html` - rendered version as a html safe string
+
+When using on a model, it expects a format (string) column exists and for each field the following:
+
+* `#{field}` - stores the original, editable content (in whichever format is specified)
+* `rendered_#{field}` - stores the converted field value
+
+When rendering a form, please note you can also get a set of formats for a select field using
+`AlmostHappy::Convertor.for_select`.
+
+## Note on Patches/Pull Requests ##
+ 
+1. Fork the project.
+2. Make your feature addition or bug fix.
+3. Add tests for it. This is important so I don't break it in a future version unintentionally.
+4. Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+5. Send me a pull request. Bonus points for topic branches.
+
+## Copyright ##
+
+Copyright (c) 2010 Darcy Laycock. See LICENSE for details.
+

data/Rakefile

@@ -0,0 +1,47 @@
+require 'rubygems'
+require 'rake'
+require 'lib/almost_happy'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name        = "almost-happy"
+    gem.summary     = %Q{Simple tools for AR + Rails 3 to help make managing your content easy}
+    gem.description = %Q{Helpers, convertors etc for Rails 3 to make page / post models for simple cases simple}
+    gem.email       = "sutto@sutto.net"
+    gem.homepage    = "http://github.com/Sutto/almost-happy"
+    gem.authors     = ["Darcy Laycock"]
+    gem.version     = AlmostHappy::VERSION
+    gem.add_dependency "activerecord", ">= 3.0.0.beta3"
+    gem.add_dependency "RedCloth"
+    gem.add_dependency "rdiscount"
+    gem.add_dependency "nokogiri"
+    gem.add_development_dependency "shoulda", ">= 0"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test    => :check_dependencies
+task :default => :test

data/almost-happy.gemspec

@@ -0,0 +1,72 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{almost-happy}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Darcy Laycock"]
+  s.date = %q{2010-05-03}
+  s.description = %q{Helpers, convertors etc for Rails 3 to make page / post models for simple cases simple}
+  s.email = %q{sutto@sutto.net}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "almost-happy.gemspec",
+     "lib/almost-happy.rb",
+     "lib/almost_happy.rb",
+     "lib/almost_happy/active_record_mixin.rb",
+     "lib/almost_happy/convertable.rb",
+     "lib/almost_happy/convertor.rb",
+     "lib/almost_happy/format_validator.rb",
+     "lib/almost_happy/publishable.rb",
+     "lib/almost_happy/scopeable.rb",
+     "test/helper.rb",
+     "test/test_almost-happy.rb"
+  ]
+  s.homepage = %q{http://github.com/Sutto/almost-happy}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Simple tools for AR + Rails 3 to help make managing your content easy}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_almost-happy.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activerecord>, [">= 3.0.0.beta3"])
+      s.add_runtime_dependency(%q<RedCloth>, [">= 0"])
+      s.add_runtime_dependency(%q<rdiscount>, [">= 0"])
+      s.add_runtime_dependency(%q<nokogiri>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<activerecord>, [">= 3.0.0.beta3"])
+      s.add_dependency(%q<RedCloth>, [">= 0"])
+      s.add_dependency(%q<rdiscount>, [">= 0"])
+      s.add_dependency(%q<nokogiri>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, [">= 3.0.0.beta3"])
+    s.add_dependency(%q<RedCloth>, [">= 0"])
+    s.add_dependency(%q<rdiscount>, [">= 0"])
+    s.add_dependency(%q<nokogiri>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+  end
+end
+

data/lib/almost-happy.rb

@@ -0,0 +1 @@
+require 'almost_happy'

data/lib/almost_happy.rb

@@ -0,0 +1,22 @@
+require 'active_support'
+require 'active_support/dependencies/autoload'
+require 'active_support/core_ext/class/attribute'
+require 'active_support/concern'
+
+module AlmostHappy
+  VERSION = '0.1.0'.freeze
+  
+  extend ActiveSupport::Autoload
+  
+  autoload :ActiveRecordMixin
+  
+  autoload :Convertor
+  autoload :FormatValidator
+  
+  autoload :Convertable
+  autoload :Scopeable
+  autoload :Publishable
+  
+  ::ActiveRecord::Base.send :include, ActiveRecordMixin if defined?(::ActiveRecord::Base)
+  
+end

data/lib/almost_happy/active_record_mixin.rb

@@ -0,0 +1,27 @@
+module AlmostHappy
+  module ActiveRecordMixin
+    extend ActiveSupport::Concern
+    
+    module ClassMethods
+      
+      def is_convertable(*args)
+        include AlmostHappy::Convertable
+        options = args.extract_options!
+        fields  = args.map { |arg| arg.to_sym }.uniq
+        self.convertable_fields += fields
+        # Define accessors for each field.
+        fields.each do |field|
+          define_method(:"#{field}_as_html") { send(field).to_s.html_safe }
+        end
+        validate_convertable_format if options.fetch(:validate, true)
+      end
+      
+      def is_publishable
+        include AlmostHappy::Publishable
+        include AlmostHappy::Scopeable
+      end
+      
+    end
+    
+  end
+end

data/lib/almost_happy/convertable.rb

@@ -0,0 +1,39 @@
+require 'set'
+
+module AlmostHappy
+  module Convertable
+    extend ActiveSupport::Concern
+    
+    included do
+      class_attribute :convertable_fields
+      self.convertable_fields = Set.new
+      before_save :process_convertable_sections
+    end
+    
+    module ClassMethods
+      
+      def validate_convertable_format
+        validates_presence_of :format
+        validates_with AlmostHappy::FormatValidator
+      end
+      
+    end
+    
+    module InstanceMethods
+      
+      protected
+      
+      def process_convertable_sections
+        convertable_fields.each do |field|
+          AlmostHappy::Convertor.new(self, field).render if should_render?(field)
+        end
+      end
+      
+      def should_render?(field)
+        send(:"rendered_#{field}").blank? || format_changed? || send(:"#{field}_changed?")
+      end
+      
+    end
+    
+  end
+end

data/lib/almost_happy/convertor.rb

@@ -0,0 +1,93 @@
+module AlmostHappy
+  class Convertor
+    
+    class Renderer < Struct.new(:name, :options, :renderer)
+
+      def [](key)
+        options[key.to_sym]
+      end
+
+      def render(content)
+        renderer.call(content.to_s).to_s.html_safe
+      end
+
+      def human_name
+        ::I18n.t(name, :scope => :"almost_happy.renderers.human_names", :default => name.to_s.humanize)
+      end
+
+    end
+
+    class_attribute :renderers, :renderer_options
+    self.renderers = {}
+
+    def self.add_renderer(key, *args, &blk)
+      options = args.extract_options!
+      renderer = (args.pop || blk).to_proc
+      self.renderers[key.to_s] = Renderer.new(key, options, renderer)
+    end
+
+    def self.render_for(key, content)
+      renderer = self.renderers[key.to_s]
+      content  = content.to_s
+      renderer.present? ? renderer.render(content) : content
+    end
+
+    def self.for_select
+      self.renderers.values.map do |r|
+        [r.human_name, r.name.to_s]
+      end.sort
+    end
+    
+    def self.format_names
+      self.renderers.values.map { |r| r.human_name }.to_sentence :two_words_connector => " or ", :last_word_connector => ", or "
+    end
+
+    def self.[](key)
+      renderers[key.to_s].try(:options) || {}
+    end
+
+    def self.valid_format?(name)
+      renderers.keys.include? name.to_s
+    end
+
+    attr_reader :object, :source_field
+
+    def initialize(object, source_field)
+      @object       = object
+      @source_field = source_field
+    end
+
+    def original_content
+      @object.send source_field
+    end
+
+    def rendered_content=(value)
+      @object.send :"rendered_#{source_field}=", value
+    end
+
+    def to_html
+      conversion_from = @object.format rescue nil
+      self.class.render_for(conversion_from, original_content)
+    end
+
+    def render
+      self.rendered_content = self.to_html
+    end
+
+    add_renderer :textile do |raw|
+      Albino.highlight_code RedCloth.new(raw).to_html
+    end
+
+    add_renderer :markdown, :filters => [:smart, :autolink] do |raw|
+      html = RDiscount.new(raw, *ContentRenderer[:markdown].fetch(:filters, [])).to_html
+      html.gsub!(/^(?:<p>)?@@@(?:<\/p>)?$/, '</div>')
+      html.gsub!(/^(?:<p>)?@@@\s*([\w\+]+)(?:<\/p>)?$/, '<div class="code" rel="\1">')
+      Albino.highlight_code(html)
+    end
+
+    add_renderer :raw do |raw|
+      Albino.highlight_code(raw.to_s)
+    end
+    
+  end
+end

data/lib/almost_happy/format_validator.rb

@@ -0,0 +1,16 @@
+module AlmostHappy
+  class FormatValidator < ActiveModel::Validator
+    
+    def validate(record)
+      if record && record.respond_to?(:format)
+        format = record.format
+        if format.present? && !AlmostHappy::Convertor.valid_format?(format)
+          record.errors.add :format, :invalid_format,
+            :default => 'is not a valid format (must be one of {{formats}})',
+            :formats => AlmostHappy::Convertor.format_names
+        end
+      end
+    end
+    
+  end
+end

data/lib/almost_happy/publishable.rb

@@ -0,0 +1,18 @@
+module AlmostHappy
+  module Publishable
+    extend ActiveSupport::Concern
+    
+    module InstanceMethods
+      
+      def published?
+        published_at.present? && published_at <= Time.now
+      end
+      
+      def publish!
+        update_attribute :published_at, Time.now
+      end
+      
+    end
+    
+  end
+end

data/lib/almost_happy/scopeable.rb

@@ -0,0 +1,22 @@
+module AlmostHappy
+  module Scopeable
+    extend ActiveSupport::Concern
+    
+    module ClassMethods
+      
+      def published
+        where 'published_at IS NOT NULL AND published_at <= ?', Time.now
+      end
+      
+      def ordered
+        order 'published_at DESC'
+      end
+      
+      def ordered_for_preview
+        order '(published_at IS NULL) DESC, published_at DESC'
+      end
+      
+    end
+    
+  end
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'almost-happy'
+
+class Test::Unit::TestCase
+end

data/test/test_almost-happy.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestAlmostHappy < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification 
+name: almost-happy
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Darcy Laycock
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-03 00:00:00 +08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        - beta3
+        version: 3.0.0.beta3
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: RedCloth
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rdiscount
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+description: Helpers, convertors etc for Rails 3 to make page / post models for simple cases simple
+email: sutto@sutto.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- almost-happy.gemspec
+- lib/almost-happy.rb
+- lib/almost_happy.rb
+- lib/almost_happy/active_record_mixin.rb
+- lib/almost_happy/convertable.rb
+- lib/almost_happy/convertor.rb
+- lib/almost_happy/format_validator.rb
+- lib/almost_happy/publishable.rb
+- lib/almost_happy/scopeable.rb
+- test/helper.rb
+- test/test_almost-happy.rb
+has_rdoc: true
+homepage: http://github.com/Sutto/almost-happy
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Simple tools for AR + Rails 3 to help make managing your content easy
+test_files: 
+- test/helper.rb
+- test/test_almost-happy.rb