amber 0.2.6

data/lib/amber/static_page/page_properties.rb

@@ -0,0 +1,124 @@
+#
+# Holds many PropertySets for a StaticPage, one PropertySet per locale.
+#
+# setting the property (in en.haml):
+#
+#   - @title = 'hi'
+#
+# getting the property
+#
+#   page.props.title                # Uses I18n.locale
+#   page.props.prop(:es, :title)    # explicitly uses locale :es
+#
+
+require 'i18n'
+require 'time'
+require 'rubygems'
+require 'haml'
+require 'RedCloth'
+
+module Amber
+  class StaticPage
+    class PageProperties
+
+      def initialize(page=nil)
+        @page = page
+        @locales = {}
+      end
+
+      #
+      # evaluate the template_string, and load the variables defined into an AttrObject.
+      #
+      def eval(template_string, locale=I18n.default_locale)
+        locale = locale.to_sym # locales are always symbols
+
+        # render to the template to get the instance variables
+        ps = PropertySet.new
+        begin
+          # template is evaluated with binding of ps object
+          Haml::Engine.new(template_string, :format => :html5).render(ps)
+        rescue Exception => exc
+          raise exc if defined?(TESTING)
+        end
+
+        # convert date/time variables to objects of class Time
+        ps.instance_variables.grep(/_at$/).each do |time_variable|
+          ps.instance_variable_set(time_variable, Time.parse(ps.instance_variable_get(time_variable)))
+        end
+
+        # save the AttrObject
+        @locales[locale] = ps
+      end
+
+      #
+      # allows property_set.propname shortcut, assumes default locale
+      #
+      def method_missing(method)
+        prop(I18n.locale, method)
+      end
+
+      #def locale(l)
+      #  @locales[l.to_sym] || @locales[I18n.default_locale]
+      #end
+
+      #
+      # get an attribute value for a particular locale.
+      # if `inherited` is true, we do not consider special non-inheritable properties.
+      #
+      def prop(locale, var_name, inherited=false)
+        return nil unless locale
+        properties = @locales[locale.to_sym]
+        value = (properties.get(var_name, inherited) if properties)
+        if value.nil? && locale != I18n.default_locale
+          properties = @locales[I18n.default_locale]
+          value = properties.get(var_name, inherited) if properties
+        end
+        if value.nil? && @page && @page.parent
+          value = @page.parent.prop(locale, var_name,  true)
+        end
+        value
+      end
+
+      #
+      # like prop(), but does not allow inheritance
+      #
+      def prop_without_inheritance(locale, var_name)
+        properties = @locales[locale.to_sym]
+        if properties
+          properties.get(var_name)
+        else
+          nil
+        end
+      end
+
+      #
+      # like prop_without_inheritance, but defaults to default_locale and tries multiple properties
+      #
+      def prop_with_fallback(locale, var_names)
+        [locale, I18n.default_locale].each do |l|
+          var_names.each do |var|
+            value = prop_without_inheritance(l, var)
+            return value if value
+          end
+        end
+        return nil
+      end
+
+      def set_prop(locale, var_name, value)
+        properties = @locales[locale.to_sym]
+        if properties
+          properties.set(var_name, value)
+        end
+      end
+
+      #
+      # tries to get the value of an inherited variable
+      #
+      #def get_inherited_var(var_name, locale=I18n.locale)
+      #  if @page && @page.parent && @page.parent.props
+      #    @page.parent.props.get_var(var_name, locale)
+      #  end
+      #end
+    end
+  end
+end

data/lib/amber/static_page/property_set.rb

@@ -0,0 +1,78 @@
+#
+# A simple class to hold a set of properties for a page.
+#
+# There is a separate property set for each locale. The PageProperties object holds many PropertySets, one
+# for each locale.
+#
+# When the template for a page is evaluated, all the member variabled defined in that template
+# are loaded as member variables of the PropertySet instance. (e.g. properties are eval'ed
+# in context of PropertySet instance)
+#
+# the "@this" variable is to set variables that should not be inherited
+#
+
+module Amber
+  class StaticPage
+    class PropertySet
+
+      def initialize
+        @this = ThisPropertySet.new
+      end
+
+      def method_missing(method, *args)
+        if method =~ /=$/
+          set(method, args.first)
+        else
+          get(method)
+        end
+      end
+
+      def textile(str)
+        RedCloth.new(str).to_html
+      end
+
+      #
+      # get the value of a property
+      #
+      # the @this properties are non-inheritable. If `inheritable_only` is true, we don't consider them
+      # when returning the property value.
+      #
+      def get(property_name, inheritable_only=false)
+        if inheritable_only || @this.nil?
+          instance_variable_get("@#{property_name}")
+        else
+          value = @this.get(property_name)
+          if value.nil?
+            value = instance_variable_get("@#{property_name}")
+          end
+          value
+        end
+      end
+
+      #
+      # set the value of a property
+      #
+      # if the property has a non-nil value set in the @this prop set, then we set it there.
+      # otherwise, it is set in the inheritable set.
+      #
+      def set(property_name, value)
+        property_name = property_name.to_s.sub(/=$/, '')
+        instance_variable = "@" + property_name
+        if @this.nil? || @this.get(property_name).nil?
+          instance_variable_set(instance_variable, value)
+        else
+          @this.instance_variable_set(instance_variable, value)
+        end
+      end
+
+      def to_s
+        "<" + instance_variables.map{|v| "#{v}=#{instance_variable_get(v)}"}.join(', ') + ">"
+      end
+    end
+
+    class ThisPropertySet < PropertySet
+      def initialize
+      end
+    end
+  end
+end

data/lib/amber/static_page/render.rb

@@ -0,0 +1,122 @@
+#
+# All the StaticPage code that deals with rendering
+#
+
+require 'i18n'
+require 'fileutils'
+require 'pathname'
+
+module Amber
+  class StaticPage
+
+    #
+    # render without layout, possibly with via a rails request
+    #
+    # RAILS
+    # def render_to_string(renderer=nil)
+    #   begin
+    #     render_locale(renderer, I18n.locale)
+    #   rescue ActionView::MissingTemplate, MissingTemplate => exc
+    #     begin
+    #       render_locale(renderer, I18n.default_locale)
+    #     rescue
+    #       Amber.logger.error "ERROR: could not file template path #{self.template_path}"
+    #       raise exc
+    #     end
+    #   end
+    # end
+
+    #
+    # render a static copy
+    #
+    # dest_dir - e.g. amber_root/public/
+    #
+    def render_to_file(dest_dir, options={})
+      render_content_files(dest_dir, options)
+      render_assets(dest_dir)
+      if aliases.any?
+        link_page_aliases(dest_dir)
+      end
+    end
+
+    private
+
+    # RAILS
+    # def render_locale(renderer, locale)
+    #   if renderer && is_haml_template?(locale)
+    #     renderer.render_to_string(:template => self.template_path(locale), :layout => false).html_safe
+    #   else
+    #     render_static_locale(locale).html_safe
+    #   end
+    # end
+
+    # RAILS
+    # def render_static_locale(locale)
+    #   content_files.each do |file_locale, content_file|
+    #     if locale == file_locale
+    #       return Render::View.new(self, self.mount_point).render({file: content_file}, {locale: file_locale})
+    #     end
+    #   end
+    #   raise MissingTemplate.new(template_path(locale))
+    # end
+
+    # called only by render_to_file
+    def render_assets(dest_dir)
+      asset_files.each do |asset_file|
+        src_file = File.join(@file_path, asset_file)
+        dst_file = File.join(dest_dir, *@path, asset_file)
+        Render::Asset.render(src_file, dst_file)
+      end
+    end
+
+    # called only by render_to_file
+    # for now, we only support aliases on pages that are directories, for simplicity sake.
+    def link_page_aliases(dest_dir)
+      if @simple_page
+        Amber.logger.warn { "The page `#{@file_path}` sets a path alias, but currently aliases are only supported for directory-based pages. Skipping." }
+      else
+        aliases.each do |alias_path|
+          alias_path = Pathname.new(File.join(dest_dir, alias_path))
+          if !File.directory?(File.dirname(alias_path))
+            Amber.logger.warn { "On page `#{@file_path}`, the parent directories for alias name `#{alias_path}` don't exist. Skipping alias." }
+          else
+            page_path = Pathname.new(File.join(dest_dir, *@path))
+            target = page_path.relative_path_from(alias_path).to_s.sub(/^\.\.\//, '')
+            if File.exists?(alias_path)
+              if File.symlink?(alias_path)
+                File.unlink(alias_path)
+                Amber.logger.debug { "Alias #{alias_path} => #{target}" }
+                FileUtils.ln_s(target, alias_path)
+              else
+                Amber.logger.warn { "The page `#{@file_path}` sets a path alias, but there is already a file in the way (`#{alias_path}`)" }
+              end
+            else
+              Amber.logger.debug { "Alias #{alias_path} => #{target}" }
+              FileUtils.ln_s(target, alias_path)
+            end
+          end
+        end
+      end
+    end
+
+    # called only by render_to_file
+    def render_content_files(dest_dir, options)
+      view = Render::View.new(self, self.mount_point)
+      @mount_point.locales.each do |file_locale|
+        content_file = content_file(file_locale)
+        next unless content_file
+        dest = destination_file(dest_dir, file_locale)
+        unless Dir.exists?(File.dirname(dest))
+          FileUtils.mkdir_p(File.dirname(dest))
+        end
+        if options[:force] || !File.exist?(dest) || File.mtime(content_file) > File.mtime(dest)
+          File.open(dest, 'w') do |f|
+            layout = @props.layout || 'default'
+            f.write view.render({file: content_file, layout: layout}, {locale: file_locale})
+          end
+        end
+      end
+    end
+
+  end
+end

metadata

@@ -0,0 +1,203 @@
+--- !ruby/object:Gem::Specification
+name: amber
+version: !ruby/object:Gem::Version
+  version: 0.2.6
+  prerelease: 
+platform: ruby
+authors:
+- Elijah Sparrow
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: haml-contrib
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: RedCloth
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdiscount
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+- !ruby/object:Gem::Dependency
+  name: tilt
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: sass
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: Amber is a super simple and super flexible static website generator with
+  support for nice localization and navigation.
+email:
+- elijah@riseup.net
+executables:
+- amber
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/amber.rb
+- lib/amber/cli.rb
+- lib/amber/site_configuration.rb
+- lib/amber/static_page/render.rb
+- lib/amber/static_page/page_properties.rb
+- lib/amber/static_page/property_set.rb
+- lib/amber/static_page/filesystem.rb
+- lib/amber/server.rb
+- lib/amber/site.rb
+- lib/amber/menu.rb
+- lib/amber/logger.rb
+- lib/amber/render/table_of_contents.rb
+- lib/amber/render/view.rb
+- lib/amber/render/bracketlink.rb
+- lib/amber/render/helpers/language_helper.rb
+- lib/amber/render/helpers/navigation_helper.rb
+- lib/amber/render/helpers/haml_helper.rb
+- lib/amber/render/helpers/html_helper.rb
+- lib/amber/render/autolink.rb
+- lib/amber/render/asset.rb
+- lib/amber/render/layout.rb
+- lib/amber/render/template.rb
+- lib/amber/static_page.rb
+- lib/amber/page_array.rb
+- bin/amber
+- LICENSE
+- README.md
+homepage: https://github.com/leapcode/amber
+licenses:
+- AGPL
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Static website generator
+test_files: []