yamlade 0.0.1

data/.gitignore

@@ -0,0 +1,2 @@
+pkg
+

data/MIT_LICENCE

@@ -0,0 +1,19 @@
+Copyright (c) 2009 - 2010 Mickael Riga
+
+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,119 @@
+YAMLADE - Use YAML files to cook configuration Marmelade for a website
+----------------------------------------------------------------------
+
+WHAT DOES IT DO ?
+-----------------
+
+Yamlade is made for config files of a web application.
+Things that should be unique but still editable in a CMS.
+Basically, Yamlade helps you with the CMS part of it, building the forms for you
+and dealing with the updates.
+
+HOW TO INSTALL IT ?
+-------------------
+
+	# sudo gem install yamlade
+	
+And then require it:
+
+	require 'yamlade'
+
+HOW TO USE IT ?
+---------------
+
+Just create your YAML file with keys followed by 2 underscores and the type of field.
+ex: options.yml
+
+	___
+	publish__boolean:
+	full_title__string:
+	content__text:
+	banner__file: desired_file_name.jpeg
+	logo__data:
+
+And then you're ready to go.
+
+	require 'yamlade'
+	@conf = Yamlade.new('options.yml')
+	
+If you want to get the html form for your config file:
+
+	@conf.to_form(action_url)
+	
+Or just this if you only need the fields to wrap them in your own form:
+
+	@conf.to_fields
+	
+And when the POST request arrives, your object is in the 'yaml' key. So use it for updating your file:
+
+	@conf.update(request['yaml'])
+	
+That's it, only three methods for the moment.
+See examples if you're not sure.
+I'll try to put examples for as many frameworks as i can.
+
+HOW ARE MY FILES HANDLED WITH 'FILE' TYPE ?
+-------------------------------------------
+
+If you use the file type, the uploaded file is loaded on the file system.
+So in that case, it might be important to specify the second argument of the constructor : public root
+If you don't, Yamlade consider the folder called 'public' next to your YAML file as the public root.
+
+	conf = Yamlade.new('conf.yml', ::File.expand_path('../public/', 'conf.yml'))
+	
+The other thing to know, is that you have to give a name when building Yaml file the first time.
+Basicaly you force the name of the file instead of keeping the original file name.
+It helps Yamlade to overwrite the previously recorded file.
+That way also allows you to give paths deeper than public root if necessary:
+
+	header__file: layout/header.jpeg
+	
+
+HOW ARE MY FILES HANDLED WITH 'DATA' TYPE ?
+-------------------------------------------
+
+Well, in fact the file will be included in your YAML if you use the data type.
+The main reason for that is that it's cool to have everything in one file.
+The way it's recorded is with the handy data URI scheme : http://en.wikipedia.org/wiki/Data_URI_scheme
+But you don't have to think about that because Yamlade works for you.
+Just use the value like if it was a URL:
+
+	<% @options = YAML.load_file('options.yml') %>
+	<img src="<%= @options.logo %>" />
+	
+!!! You don't use Yamlade class here. Reading is made through a classic YAML loading and reading.
+
+!!! At this day, data scheme doesn't work on IE<=7 and is limited to 32kb on IE8
+
+WHAT IF I WANT TO USE 'DATA' TYPE ANYWAY ?
+------------------------------------------
+
+The best thing to do might be to do some MHTML trick:
+http://www.phpied.com/data-uris-mhtml-ie7-win7-vista-blues/
+
+An other way is possible if you really want to keep everything in one file.
+Dynamically serve those images.
+This is not recommended because it produces useless computing (maybe acceptable for a couple of pics)
+
+Basicaly, you need to have an action that reads the information, set the right mime-type and decoded content.
+Here is a Ramaze example:
+
+	def data(file, var)
+    @conf = YAML.load_file(::File.expand_path("../../private/#{file}.yml", __FILE__))
+    mime, data = @conf[var].split(/,/)
+    response['Content-Type'] = mime[/[^:]*\/[^;]*/]   # remove what is around the mime-type
+    response.status = 200
+    response.write data.unpack("m")[0]                # decode base64
+   	throw(:respond, response)
+	end
+
+And then you can have your pictures with urls like : /data/conf/logo__data
+
+I removed the preview when editing this kind of file in order to allow that trick.
+Maybe I'll try to find a way to deal both situations...
+
+(C)
+---
+
+Copyright (c) 2009 - 2010 Mickael Riga - See MIT_LICENCE for more details
+	

data/examples/options.yml

@@ -0,0 +1,6 @@
+--- 
+banner__file: my_picture.jpeg
+publish__boolean: "false"
+logo__data: 
+box_content__text: 
+title__string: 

data/examples/rack.ru

@@ -0,0 +1,33 @@
+# Start me with : rackup rack.ru
+# Default port is 9292
+
+require File::expand_path('../yamlade', File.dirname(__FILE__)) # When installed, just use : require 'yamlade'
+
+# PUBLIC ROOT
+
+map '/' do
+  run Rack::File.new(File.expand_path('./public', File.dirname(__FILE__)))
+end
+
+# EDIT
+
+map '/edit' do
+  run lambda { |env|
+    request = Rack::Request.new(env)
+
+    @conf = Yamlade.new("options.yml")
+    if request.post?
+      @conf.update(request['yaml'])
+    end
+
+    [ 200, {'Content-Type' => 'text/html'}, @conf.to_form(request.path_info) + "<br /><br /><a href='/inspect'>&gt;&gt; INSPECT</a>" ]
+  }
+end
+
+# INSPECT
+
+map '/inspect' do
+  run lambda { |env|
+    [ 200, {'Content-Type' => 'text/html'}, YAML.load_file("options.yml").inspect ]
+  }
+end

data/examples/ramaze.ru

@@ -0,0 +1,27 @@
+# Start me with : rackup ramaze.ru
+# Default port is 9292
+
+require 'rubygems'
+require 'ramaze'
+require File::expand_path('../yamlade', File.dirname(__FILE__)) # When installed, just use : require 'yamlade'
+
+class MainController < Ramaze::Controller
+ 
+  # /
+  def index
+    @conf = Yamlade.new("options.yml")
+    if request.post?
+      @conf.update(request['yaml'])
+    end
+    @conf.to_form(request.path_info) + "<br /><br /><a href='/inspect'>&gt;&gt; INSPECT</a>"
+  end
+  
+  # /inspect
+  def inspect
+    YAML.load_file("options.yml").inspect
+  end
+  
+end
+
+Ramaze.start(:root => __DIR__, :started => true, :mode => :dev)
+run Ramaze

data/examples/sinatra.ru

@@ -0,0 +1,28 @@
+# Start me with : rackup rack.ru
+# Default port is 9292
+
+require 'sinatra/base'
+require File::expand_path('../yamlade', File.dirname(__FILE__)) # When installed, just use : require 'yamlade'
+
+class SinatrApp < Sinatra::Base
+  set :app_file, __FILE__
+  set :root, File.dirname(__FILE__)
+
+  get '/?' do
+    @conf = Yamlade.new("options.yml")
+    @conf.to_form(request.path_info) + "<br /><br /><a href='/inspect'>&gt;&gt; INSPECT</a>"
+  end
+  
+  post '/?' do
+    @conf = Yamlade.new("options.yml")
+    @conf.update(request['yaml'])
+    @conf.to_form(request.path_info) + "<br /><br /><a href='/inspect'>&gt;&gt; INSPECT</a>"
+  end
+  
+  get '/inspect' do
+    YAML.load_file("options.yml").inspect
+  end
+  
+end
+
+run SinatrApp

data/yamlade.gemspec

@@ -0,0 +1,12 @@
+Gem::Specification.new do |s| 
+  s.name = 'yamlade'
+  s.version = "0.0.1"
+  s.platform = Gem::Platform::RUBY
+  s.summary = "Use YAML files to cook configuration Marmelade through HTML forms"
+  s.description = "Do a YAML file, and Yamlade take care of the HTML forms for you"
+  s.files = `git ls-files`.split("\n").sort
+  s.require_path = '.'
+  s.author = "Mickael Riga"
+  s.email = "mig@mypeplum.com"
+  s.homepage = "http://github.com/mig-hub/yamlade"
+end

data/yamlade.rb

@@ -0,0 +1,69 @@
+require 'yaml'
+class Yamlade
+  def initialize(f, public_root=::File.expand_path('../public/', f))
+    @file = f
+    @public_root =  public_root
+    @public_root << '/' unless public_root[/\/$/]
+  end
+  def to_fields
+    o = "<h3>#{::File.basename(@file, '.yml').upcase.tr('_', ' ')}</h3>"
+    config = YAML.load_file(@file)
+    config.each do |k,v|
+      label, type = k.split('__')
+      o << "<p>#{label.capitalize.tr('_', ' ')}<br />"
+      
+      o << case type
+      when 'string'
+        "<input type='text' value='#{v}' name='yaml[#{k}]' />"
+      when 'text'
+        "<textarea cols='40' rows='5' name='yaml[#{k}]'>#{v}</textarea>"
+      when 'file'
+        preview = (v.nil? || v=='') ? '' : "<img src='/#{v}' width='100' /><br />"
+        "#{preview}<input type='file' name='yaml[#{k}]' />"
+      when 'data'
+        "<input type='file' name='yaml[#{k}]' />"
+      when 'boolean'
+        s = [' checked', nil]
+        s.reverse! unless v=='true'
+        %{
+          <input type='radio' name='yaml[#{k}]' value='true'#{s[0]} /> True<br />
+          <input type='radio' name='yaml[#{k}]' value='false'#{s[1]} /> False
+        }.strip
+      end
+      
+      o << '</p>'
+    end
+    o
+  end
+  
+  def to_form(url)
+    "<form action='#{url}' method='POST' enctype='multipart/form-data'>#{self.to_fields}<input type='submit' name='save' value='SAVE' /></form>"
+  end
+  
+  def update(h)
+    config = YAML.load_file(@file)
+    # Data
+    datas = h.find_all {|k,v| k[/_data$/] }
+    datas.each do |data|
+      field, data_hash = data
+      tempfile, content_type = data_hash.values_at(:tempfile, :type)
+      h[field] = "data:#{content_type};base64,#{[::File.open(tempfile.path).read].pack('m').strip}"
+      tempfile.close(true)
+    end
+    # File
+    files = h.find_all {|k,v| k[/_file$/] }
+    files.each do |file|
+      field, file_hash = file
+      tempfile, content_type = file_hash.values_at(:tempfile, :type)
+      unless config[field].to_s.empty? or tempfile.nil?
+        FileUtils.move(tempfile.path, "#{@public_root}#{config[field]}", :force => true)
+        FileUtils.chmod(0777, "#{@public_root}#{config[field]}")
+        tempfile.close(true)
+      end
+      h.delete(field)
+    end
+    # Update
+    config = config.update(h)
+    ::File.open(@file, 'w') {|f| YAML.dump(config, f) }
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: yamlade
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Mickael Riga
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-02 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: Do a YAML file, and Yamlade take care of the HTML forms for you
+email: mig@mypeplum.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- MIT_LICENCE
+- README.md
+- examples/options.yml
+- examples/public/my_picture.jpeg
+- examples/rack.ru
+- examples/ramaze.ru
+- examples/sinatra.ru
+- yamlade.gemspec
+- yamlade.rb
+has_rdoc: true
+homepage: http://github.com/mig-hub/yamlade
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- .
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Use YAML files to cook configuration Marmelade through HTML forms
+test_files: []
+