openskip-skip_embedded 0.0.15

data/ChangeLog

@@ -0,0 +1,4 @@
+== 0.0.9 / 2009-03-02
+
+* initial release
+

data/README.rdoc

@@ -0,0 +1,37 @@
+
+= skip_embedded
+
+Utilities to collabolate SKIP, opensource buisiness SNS.
+
+== Description
+
+skip_embedded make to build skip-collaborate apps easy,
+  it have the features...
+
+- Create SKIP style fulltext search cache.
+
+== Installation
+
+=== Archive Installation
+
+	rake install
+
+=== Gem Installation
+
+	gem install skip_embedded
+
+
+== Features/Problems
+
+ lator
+
+== Synopsis
+
+ lator
+
+== Copyright
+
+Author::    MOROHASHI Kyosuke k-morohashi@esm.co.jp
+Copyright:: Copyright (c) 2009 SonicGraden LLC # FIXME
+License:: GPL v3
+

data/Rakefile

@@ -0,0 +1,87 @@
+require 'rubygems'
+require 'rake'
+require 'rake/rdoctask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'lib/skip_embedded'
+
+desc 'Default: run unit tests.'
+task :default => :spec
+
+require 'spec/rake/spectask'
+
+desc "Run all specs in spec directory"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts = %w[--colour --format progress --loadby --reverse]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+desc 'Generate documentation for the skip_embedded plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SkipEmbedded'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+NAME              = ENV["GEMNAME"] || "skip_embedded"
+AUTHOR            = "MOROHASHI Kyosuke"
+EMAIL             = "k-morohashi@esm.co.jp"
+DESCRIPTION       = "Utilities to collabolate SKIP, opensource buisiness SNS."
+HOMEPATH          = "http://github.com/openskip/skip_embedded/tree/master"
+BIN_FILES         = %w(  )
+
+VERS              = SkipEmbedded::Version
+REV = File.read(".svn/entries")[/committed-rev="(d+)"/, 1] rescue nil
+RDOC_OPTS = [
+	'--title', "#{NAME} documentation",
+	"--charset", "utf-8",
+	"--opname", "index.html",
+	"--line-numbers",
+	"--main", "README.rdoc",
+	"--inline-source",
+]
+
+spec = Gem::Specification.new do |s|
+	s.name              = NAME
+	s.version           = VERS
+	s.platform          = Gem::Platform::RUBY
+	s.has_rdoc          = true
+	s.extra_rdoc_files  = ["README.rdoc", "ChangeLog"]
+	s.rdoc_options     += RDOC_OPTS + ['--exclude', '^(examples|extras)/']
+	s.summary           = DESCRIPTION
+	s.description       = DESCRIPTION
+	s.author            = AUTHOR
+	s.email             = EMAIL
+	s.homepage          = HOMEPATH
+	s.executables       = BIN_FILES
+	s.bindir            = "bin" unless BIN_FILES.empty?
+	s.require_path      = "lib"
+	s.test_files        = Dir["spec/**/*_spec.rb"]
+
+	s.files = %w(README.rdoc ChangeLog Rakefile) +
+		Dir.glob("{bin,doc,test,lib,templates,generators,extras,website,script}/**/*") + 
+		Dir.glob("spec/**/*.rb") +
+		Dir.glob("ext/**/*.{h,c,rb}") +
+		Dir.glob("examples/**/*.rb") +
+		Dir.glob("tools/*.rb") +
+		Dir.glob("rails/*.rb")
+
+	s.extensions = FileList["ext/**/extconf.rb"].to_a
+end
+
+Rake::GemPackageTask.new(spec) do |p|
+	p.need_tar = true
+	p.gem_spec = spec
+end
+
+desc 'Show information about the gem.'
+task :debug_gem do
+	puts spec.to_ruby
+end
+
+desc 'Update gem spec'
+task :gemspec do
+  open("#{NAME}.gemspec", 'w').write spec.to_ruby
+end

data/generators/skip_embedded/skip_embedded_generator.rb

@@ -0,0 +1,30 @@
+class SkipEmbeddedGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      assets = %w[
+        app/views/shared/_flash_message.html.erb
+        app/views/shared/_skip_full_text_search_form.html.erb
+        public/javascripts/dropdown_navigation.js
+        public/javascripts/labeled_text_field.js
+        public/javascripts/skip_fckeditor_config.js
+        public/stylesheets/skip_embedded.css
+      ]
+
+      assets.map{|asset| File.dirname(asset) }.uniq.each{|asset| m.directory(asset) }
+      assets.each{|asset| m.file asset, asset }
+
+      insert_helper(m) unless options[:pretend]
+    end
+  end
+
+  private
+  def insert_helper(manifest, text = "\n  include SkipEmbedded::Helpers", helper = "app/helpers/application_helper.rb")
+    logger.edit_helper(helper)
+    case options[:command]
+    when :create
+      manifest.gsub_file(helper, /^module ApplicationHelper$/){|head| head + text }
+    when :destroy
+      manifest.gsub_file(helper, text, '')
+    end
+  end
+end

data/generators/skip_embedded/templates/app/views/shared/_flash_message.html.erb

@@ -0,0 +1,13 @@
+<div id="flash_message">
+  <%= render_flash(:error) %>
+  <%= render_flash(:warn) %>
+  <%= render_flash(:notice) %>
+</div>
+
+<%- javascript_tag do %>
+  jQuery(document).ready(function(){
+    $("#flash_message div").click(function(){$(this).fadeOut("slow")});
+    setTimeout(function(){ $("#flash_message div.notice").trigger("click"); }, 2*1000);
+    setTimeout(function(){ $("#flash_message div.warn").trigger("click"); }, 5*1000);
+  });
+<% end %>

data/generators/skip_embedded/templates/app/views/shared/_skip_full_text_search_form.html.erb

@@ -0,0 +1,24 @@
+<%
+  config = SkipEmbedded::InitialSettings["skip_collaboration"]["fulltext_search"]
+  endpoint = config["endpoint"]
+  query_name = config["full_text_query"]
+  search_label = _("Input keyword to search")
+
+  unless endpoint =~ /\Ahttp(s)?:\/\//
+    endpoint = SkipEmbedded::InitialSettings["skip_collaboration"]["skip_url"] + endpoint
+  end
+%>
+
+<div id="search">
+  <% form_tag(endpoint, :method => 'get', :class => 'skip_fulltext_search') do -%>
+    <%= text_field_tag(query_name, search_label, :class => "labeled-field", :size => 40) %>
+    <%= submit_tag _('Search') %>
+  <% end -%>
+
+  <% javascript_tag do %>
+    jQuery(function(){
+      jQuery("#search input.labeled-field").labeledTextField(<%= {:message => search_label}.to_json %>);
+    });
+  <% end %>
+</div>
+

data/generators/skip_embedded/templates/public/javascripts/dropdown_navigation.js

@@ -0,0 +1,12 @@
+(function() {
+  jQuery.fn.dropdownNavigation = function(config){
+    function navigate(){
+      var loc = jQuery(this).val();
+      if("" != loc){ document.location = loc };
+      return false;
+    };
+
+    return jQuery(this).change(navigate);
+  }
+})(jQuery);
+

data/generators/skip_embedded/templates/public/javascripts/labeled_text_field.js

@@ -0,0 +1,21 @@
+(function() {
+  jQuery.fn.labeledTextField = function(config){
+    var target = jQuery(this);
+    var focusClass = config["focusClass"] || "focus";
+    var message = config["message"];
+
+    target.parents("form").get(0).reset();
+    if(target.val() != message){ target.addClass(focusClass); };
+
+    target.focus(function(){
+        target.addClass(focusClass);
+        if(target.val() == message){ target.val("") };
+      });
+    target.blur(function(){
+        if(target.val() == ""){
+          target.removeClass(focusClass).val(message);
+        };
+      });
+  };
+})(jQuery);
+

data/generators/skip_embedded/templates/public/javascripts/skip_fckeditor_config.js

@@ -0,0 +1,45 @@
+
+FCKConfig.EditorAreaCSS = FCKConfig.BasePath + '../../../stylesheets/application.css' ;
+
+FCKConfig.Plugins.Add( 'autogrow' ) ;
+FCKConfig.Plugins.Add( 'dragresizetable' );
+FCKConfig.AutoGrowMax = 1000 ;
+
+FCKConfig.BodyId = 'fckedit' ;
+FCKConfig.BodyClass = 'rich_style' ;
+
+FCKConfig.DefaultLanguage               = 'ja' ;
+FCKConfig.SkinPath = FCKConfig.BasePath + 'skins/silver/';
+
+FCKConfig.ToolbarSets["Normal"] = [
+        ['Cut','Copy','Paste','PasteText','PasteWord'],
+        ['Undo','Redo','RemoveFormat'],
+        ['Bold','Italic','Underline','StrikeThrough'],
+        ['OrderedList','UnorderedList'],
+        ['JustifyLeft','JustifyCenter','JustifyRight','JustifyFull'],
+        ['TextColor','BGColor'],
+        ['Table','Rule','Smiley'],
+        '/',
+        ['FontName','FontFormat','FontSize'],
+        ['Link','Unlink'],
+        ['Source','Preview'],
+        ['FitWindow','ShowBlocks','-','About']          // No comma for the last row.
+] ;
+
+FCKConfig.ToolbarSets["Light"] = [
+        ['Undo','Redo'],
+        ['Bold','Italic','Underline','StrikeThrough','RemoveFormat'],
+        ['TextColor','BGColor','Smiley'],
+        '/',
+        ['FontName','FontFormat','FontSize']           // No comma for the last row.
+] ;
+
+FCKConfig.LinkBrowser = false ;
+FCKConfig.ImageBrowser = false ;
+FCKConfig.FlashBrowser = false ;
+FCKConfig.LinkUpload = false ;
+FCKConfig.ImageUpload = false ;
+FCKConfig.FlashUpload = false ;
+
+FCKConfig.FontNames             = "'ＭＳ Ｐゴシック';'ＭＳ Ｐ明朝';'ＭＳ ゴシック';'ＭＳ 明朝';MS UI Gothic;Arial;Comic Sans MS;Courier New;Tahoma;Times New Roman;Verdana" ;
+

data/generators/skip_embedded/templates/public/stylesheets/skip_embedded.css

@@ -0,0 +1,79 @@
+#flash_message {
+  position: absolute;
+  top: 3px;
+  left: 15%;
+  right: 15%;
+  width: 70%;
+  z-index: 1; }
+  #flash_message div {
+    width: 100%;
+    text-align: center;
+    font-size: 12px;
+    border-width: 2px;
+    border-style: solid; }
+    #flash_message div h3 {
+      width: 100%; }
+      #flash_message div h3 span {
+        position: static;
+        font-size: 10px;
+        margin-left: 20px;
+        right: 15px;
+        top: 15px; }
+  #flash_message div.warn {
+    border-color: orange;
+    background-color: yellow; }
+  #flash_message div.notice {
+    border-color: limegreen;
+    background-color: palegreen; }
+  #flash_message div.error {
+    border-color: red;
+    background-color: pink; }
+
+div#header div#search {
+  position: absolute;
+  top: 25px;
+  right: 5px;
+}
+
+div#header div#search form {
+  margin:0;
+  padding:0;
+}
+
+div#header div#serach input {
+  font-family:Verdana,Arial,Sans-serif;
+  font-size:12px;
+  margin:0;
+  padding:2px;
+}
+
+div#header div#menu {
+  background-color:#D0E0F0;
+  border:medium none;
+  font-size:12px;
+  padding:1px 5px;
+  position:absolute;
+  right:0;
+  text-align:right;
+  top:0;
+}
+
+div#header div#menu .item {
+  float:left;
+  font-weight:bold;
+  padding:3px 10px 1px;
+}
+
+div#header div#menu .item a {
+  color:blue;
+  text-decoration:none;
+}
+
+.labeled-field {
+  border: 1px solid silver;
+  color: rgb(153, 153, 153);
+  font-size: 13px; }
+
+.labeled-field.focus {
+  color: #000000; }
+

data/lib/skip_embedded/fulltext_search_cache/builder_base.rb

@@ -0,0 +1,51 @@
+
+module SkipEmbedded
+  module FulltextSearchCache
+    class BuilderBase
+      include ActionController::UrlWriter
+      class_inheritable_accessor :entity_name
+
+      def initialize(entity)
+        @entity = entity
+      end
+
+      def filename
+        "#{entity_name}/#{@entity.id}.html"
+      end
+
+      def write_cache(mediator)
+        File.open(mediator.cache_path(self), "wb"){|f| f.write to_cache }
+      end
+
+      def to_cache
+        ERB.new(<<-HTML).result(binding)
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+    <title>#{title}</title>
+  </head>
+  <body>#{body}</body>
+</html>
+HTML
+      end
+
+      def write_meta(mediator)
+        File.open(mediator.meta_path(self), "wb"){|f| f.write to_meta.to_yaml }
+      end
+
+      def to_meta; raise NotImplementedError, "ovverride me" end
+      def title; raise NotImplementedError, "ovverride me" end
+      def body; raise NotImplementedError, "ovverride me" end
+
+      def icon_url(icon_filename = entity_name + ".gif")
+        root_url + "images/icons/" + icon_filename
+      end
+
+      private
+      def method_missing(m, *args, &block)
+        return @entity if m.to_sym == entity_name.to_sym
+        super
+      end
+    end
+  end
+end

data/lib/skip_embedded/fulltext_search_cache/mediator.rb

@@ -0,0 +1,67 @@
+require 'skip_embedded/fulltext_search_cache'
+require "skip_embedded/fulltext_search_cache/partial_loader"
+
+module SkipEmbedded
+  module FulltextSearchCache
+    class Mediator
+
+      attr_reader :cache_dir, :built
+      def initialize(options = {})
+        @options = SkipEmbedded::FulltextSearchCache::DEFAULT_OPTIONS.merge(options)
+        @cache_dir = @options[:cache_dir]
+        @built = []
+
+        if since = @options[:since]
+          @since = Integer(since).minutes.ago
+        end
+      end
+
+      def finish
+        if built.empty?
+          @options[:logger].info{ "[FULLTEXT_SEARCH_CACHE] no model to built cache" }
+        else
+          @options[:logger].info{ "[FULLTEXT_SEARCH_CACHE] built for #{built.join(", ")}" }
+        end
+      end
+
+      def build(model, builder)
+        prepare_dir(model.name.underscore)
+
+        if @since
+          model = model.scoped(:conditions => ["#{model.quoted_table_name}.updated_at > ?", @since])
+        end
+
+        loader(model).each do |obj|
+          b = builder.new(obj)
+          b.write_cache(self)
+          b.write_meta(self)
+          built << "#{obj.class.name}:#{obj.id}"
+        end
+      end
+
+      def loader(model)
+        PartialLoader.new(model, @options[:limit])
+      end
+
+      def cache_path(builder)
+        File.expand_path(builder.filename, cache_dir)
+      end
+
+      def meta_path(builder)
+        File.expand_path(builder.filename, meta_dir)
+      end
+
+      def meta_dir
+        dir, base = File.split(cache_dir)
+        File.expand_path(base + "_meta", dir)
+      end
+
+      def prepare_dir(name)
+        [cache_dir, meta_dir].each do |dir|
+          d = File.expand_path(File.join(dir, name), cache_dir)
+          FileUtils.mkdir_p(d) unless File.directory?(d)
+        end
+      end
+    end
+  end
+end

data/lib/skip_embedded/fulltext_search_cache/partial_loader.rb

@@ -0,0 +1,19 @@
+module SkipEmbedded
+  module FulltextSearchCache
+    class PartialLoader
+      def initialize(model_or_scope, limit, finder_options = {})
+        @model_or_scope = model_or_scope
+        @limit = limit
+        @finder_options = finder_options
+      end
+
+      def each
+        0.step(@model_or_scope.count, @limit) do |offset|
+          @model_or_scope.find(:all, :limit => @limit, :offset => offset).each do |model|
+            yield model
+          end
+        end
+      end
+    end
+  end
+end

data/lib/skip_embedded/fulltext_search_cache.rb

@@ -0,0 +1,38 @@
+require "fileutils"
+
+require "config/environment" unless defined? ActionController
+
+require "skip_embedded/initial_settings"
+require "skip_embedded/fulltext_search_cache/mediator"
+
+module SkipEmbedded
+  module FulltextSearchCache
+    DEFAULT_OPTIONS = {
+      :cache_dir => File.expand_path("fts_cache/app_cache", Dir.pwd),
+      :logger    => ActionController::Base.logger,
+      :limit => 1_000,
+    }.freeze
+
+    def self.build(model_and_builders, options = {})
+      if skip_url = (InitialSettings[:skip_collaboration] && InitialSettings[:skip_collaboration]["skip_url"])
+        set_default_url_options(skip_url)
+      else
+        $stderr.puts "set skip_collaboration -> skip_url in config/initial_settings.yml"
+        exit 1
+      end
+
+      mediator = Mediator.new(options)
+      model_and_builders.each{|m, b| mediator.build(m, b) }
+
+      mediator.finish
+    end
+
+    def self.set_default_url_options(url)
+      u = URI(url)
+      url_opt = { :host => u.host, :protocol => u.scheme }
+      url_opt[:port] = u.port unless (u.scheme == "http" && u.port == 80) || (u.scheme == "https" && u.port == 443)
+      ActionController::UrlWriter.default_url_options = url_opt
+    end
+  end
+end
+

data/lib/skip_embedded/helpers/ui.rb

@@ -0,0 +1,46 @@
+module SkipEmbedded
+  module Helpers
+    module Ui
+      # From. http://github.com/mojombo/clippy/tree/master
+      def clippy(copy_text, bgcolor='#FFFFFF')
+        html = <<-EOF
+          <object classid="clsid:d27cdb6e-ae6d-11cf-96b8-444553540000"
+                  width="110"
+                  height="14"
+                  id="clippy" >
+          <param name="movie" value="#{flash_path("clippy")}"/>
+          <param name="allowScriptAccess" value="always" />
+          <param name="quality" value="high" />
+          <param name="scale" value="noscale" />
+          <param NAME="FlashVars" value="text=#{copy_text}">
+          <param name="bgcolor" value="#{bgcolor}">
+          <embed src="#{flash_path("clippy")}"
+                 width="110"
+                 height="14"
+                 name="clippy"
+                 quality="high"
+                 allowScriptAccess="always"
+                 type="application/x-shockwave-flash"
+                 pluginspage="http://www.macromedia.com/go/getflashplayer"
+                 FlashVars="text=#{copy_text}"
+                 bgcolor="#{bgcolor}"
+          />
+          </object>
+        EOF
+      end
+
+      def render_flash(type)
+        if message = flash[type]
+          content_tag("div", :class => type.to_s) do
+            content_tag("h3", h(message) + content_tag("span", _("[Click to hide]")))
+          end
+        end
+      end
+
+      def flash_path(source, suffix="swf")
+        compute_public_path(source, "flash", suffix)
+      end
+    end
+  end
+end
+

data/lib/skip_embedded/helpers.rb

@@ -0,0 +1,13 @@
+module SkipEmbedded
+  module Helpers
+    include Ui
+
+    def self.included(base)
+      ActionView::Helpers::AssetTagHelper.register_javascript_expansion :skip => %w[dropdown_navigation labeled_text_field]
+      ActionView::Helpers::AssetTagHelper.register_javascript_expansion :skip_fckeditor => %w[fckeditor/fckeditor skip_fckeditor_config]
+
+      # TODO skip/style などをどの程度共通化するかを検討、それはではskip_embeddedという別名で
+      ActionView::Helpers::AssetTagHelper.register_stylesheet_expansion :skip_embedded => %w[skip_embedded]
+    end
+  end
+end

data/lib/skip_embedded/initial_settings.rb

@@ -0,0 +1,28 @@
+require 'singleton'
+
+module SkipEmbedded
+  class InitialSettings
+    include Singleton
+    def self.config=(abs_path)
+      @config_path = abs_path
+    end
+
+    def self.config
+      @config_path ||= File.expand_path("config/initial_settings.yml", Rails.root)
+    end
+
+    def self.[](key)
+      instance[key]
+    end
+
+    def initialize
+      env = defined?(RAILS_ENV) ? RAILS_ENV : "development"
+      @config = YAML.load_file(self.class.config)[env].freeze
+    end
+
+    def [](key)
+      @config[key.to_s]
+    end
+  end
+end
+

data/lib/skip_embedded/op_fixation.rb

@@ -0,0 +1,43 @@
+require 'openid'
+require 'skip_embedded/initial_settings'
+
+module SkipEmbedded
+  class OpFixation
+    cattr_accessor :servers, :sso_openid_provider_url
+
+    def self.accept?(claimed_url)
+      servers.empty? || new(*servers).accept?(claimed_url)
+    end
+
+    def self.sso_enabled?
+      @@config && !@@config["disabled"]
+    end
+
+    def self.sso_openid_logout_url
+      URI.join(sso_openid_provider_url + "logout").to_s if sso_openid_provider_url
+    end
+
+    @@config = InitialSettings['skip_collaboration']['fixed_op']
+    if sso_enabled?
+      @@servers = @@config["acceptable_op_urls"]
+      @@sso_openid_provider_url = @@config["fixed_openid_server_url"]
+    else
+      @@servers, @@sso_openid_provider_url = [], nil
+    end
+
+    def initialize(*allowed)
+      @available_servers = allowed
+    end
+
+    def accept?(claimed_url)
+      begin
+        _, services = OpenID.discover claimed_url
+        services.any?{|s| @available_servers.include?(s.server_url) }
+      rescue OpenID::DiscoveryFailure => why
+        ::OpenID::Util.logger.error "FixedOp discovery failed: #{why.message}"
+        false
+      end
+    end
+  end
+end
+