card 0.0.1 → 1.15.pre

data/lib/generators/card.rb

@@ -0,0 +1,32 @@
+# -*- encoding : utf-8 -*-
+
+require 'rails/generators'
+require 'rails/generators/active_record'
+
+class Card
+  module Generators
+    module ClassMethods
+
+      def source_root(path = nil)
+        if path
+          @_card_source_root = path
+        else
+          @_card_source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'card', generator_name, 'templates'))
+        end
+      end
+
+      # Override Rails default banner (wagn is the command name).
+      def banner
+        "wagn generate #{namespace} #{self.arguments.map(&:usage)*' '} [options]".gsub(/\s+/, ' ')
+      end
+    end
+
+    class NamedBase < ::Rails::Generators::NamedBase
+      extend ClassMethods
+    end
+    class MigrationBase < ::ActiveRecord::Generators::Base
+      extend ClassMethods
+    end
+  end
+end
+

data/lib/generators/card/format/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Generates a new format
+
+Example:
+    wagn generate card:format 01_core backup
+
+    This will create:
+        mod/01_core/format/backup_format.rb
+        spec/mod/01_core/format/backup_format_spec.rb

data/lib/generators/card/format/format_generator.rb

@@ -0,0 +1,27 @@
+# -*- encoding : utf-8 -*-
+
+require 'generators/card'
+
+class Card
+  module Generators
+    class FormatGenerator < NamedBase
+      source_root File.expand_path('../templates', __FILE__)
+
+      argument :module_name, :required => true
+      class_option 'core', :type => :boolean, aliases: '-c', :default => false, :group => :runtime, 
+       :desc=>'create format files in Card gem'
+
+      def create_files
+        mod_path = if options.core?
+            File.join Cardio.gem_root, 'mod', file_name
+          else
+            File.join 'mod', file_name
+          end
+        format_path = File.join(mod_path, 'format', "#{module_name}_format.rb")
+        spec_path = File.join(mod_path, 'spec', 'format', "#{module_name}_format_spec.rb")
+        template 'format_template.erb', format_path
+        template 'format_spec_template.erb', spec_path
+      end
+    end
+  end
+end

data/lib/generators/card/format/templates/format_spec_template.erb

@@ -0,0 +1,5 @@
+# -*- encoding : utf-8 -*-
+
+describe Card::<%= module_name.camelize %>Format do
+
+end

data/lib/generators/card/format/templates/format_template.erb

@@ -0,0 +1,3 @@
+# -*- encoding : utf-8 -*-
+class Card::<%= module_name.camelize %>Format < Card::Format
+end

data/lib/generators/card/migration/USAGE

@@ -0,0 +1,24 @@
+
+Description:
+    Generates a migration of database content. 
+    
+    To import database content from a json file move your json file to db/migrate_cards/data
+    and choose as migration name import_<filename>.
+    
+Example:
+    wagn generate card:migration better_commented_search_cards
+
+    This will create:
+    
+        db/migrate_cards/(migration_number)_(name).rb
+
+    ...which is set up to use methods in lib/card/migration.rb
+    
+    
+    wagn generate card:migration import_better_search_cards
+
+    This will create:
+    
+        db/migrate_cards/(migration_number)_(name).rb
+        
+    ...which is set up to import data from db/migrate_cards/data/better_search_cards.json

data/lib/generators/card/migration/migration_generator.rb

@@ -0,0 +1,38 @@
+# -*- encoding : utf-8 -*-
+
+require 'generators/card'
+
+class Card
+  module Generators
+    class MigrationGenerator < MigrationBase
+      source_root File.expand_path('../templates', __FILE__)
+  
+      class_option 'core', :type => :boolean, aliases: '-c', :default => false, :group => :runtime, 
+        desc: "Create card migration for card core"
+
+      def create_migration_file
+        migration_type = options['core'] ? :core_cards : :deck_cards
+        mig_paths = Cardio.migration_paths(migration_type)
+        raise "No migration directory for #{migration_type}" if mig_paths.blank?
+        set_local_assigns!
+        migration_template @migration_template, File.join( mig_paths.first, "#{file_name}.rb")
+      end
+  
+    protected
+  
+      # sets the default migration template that is being used for the generation of the migration
+      # depending on the arguments which would be sent out in the command line, the migration template 
+      # and the table name instance variables are setup.
+
+      def set_local_assigns!
+        @migration_template = "card_migration.erb"
+        @migration_parent_class = options['core'] ? 'Card::CoreMigration' : 'Card::Migration'
+        case file_name
+        when /^(import)_(.*)(?:\.json)?/
+          @migration_action = $1
+          @json_filename    = "#{$2}.json"
+        end
+      end
+    end
+  end
+end

data/lib/generators/card/migration/templates/card_migration.erb

@@ -0,0 +1,10 @@
+# -*- encoding : utf-8 -*-
+
+class <%= migration_class_name %> < <%= @migration_parent_class %>
+  def up
+<% if @migration_action == 'import' -%>
+    import_json "<%= @json_filename %>"
+<% end -%>
+    
+  end
+end

data/lib/generators/card/set/USAGE

@@ -0,0 +1,15 @@
+Description:
+    Generates new set files in mods and matching specs.
+
+Example:
+    wagn generate card:set 05_standard type tshirt
+
+    This will create:
+        mod/05_standard/set/type/tshirt.rb
+        spec/mod/05_standard/set/type/tshirt_spec.rb
+
+    wagn generate card:set 05_standard type_plus_right basic about tshirt
+
+    This will create:
+        mods/05_standard/set/type_plus_right/basic/about/tshirt.rb
+        mods/05_standard/spec/set/type_plus_right/basic/about/tshirt_spec.rb

data/lib/generators/card/set/set_generator.rb

@@ -0,0 +1,29 @@
+# -*- encoding : utf-8 -*-
+
+require 'generators/card'
+
+class Card
+  module Generators
+    class SetGenerator < NamedBase
+      source_root File.expand_path('../templates', __FILE__)
+
+      argument :set_pattern, :required => true
+      argument :anchors, :required=>true, :type=>:array
+      class_option 'core', :type => :boolean, aliases: '-c', :default => false, :group => :runtime, 
+       :desc=>'create set files in Card gem'
+
+      def create_files
+        mod_path = if options.core?
+            File.join Cardio.gem_root, 'mod', file_name
+          else
+            File.join 'mod', file_name
+          end
+        set_path  = File.join(mod_path, 'set', set_pattern, anchors[0..-2], "#{anchors.last}.rb")
+        spec_path = File.join(mod_path, 'spec', 'set', set_pattern, anchors[0..-2], "#{anchors.last}_spec.rb" )
+        template 'set_template.erb', set_path
+        template 'set_spec_template.erb', spec_path
+      end
+    end
+  end
+end
+

data/lib/generators/card/set/templates/set_spec_template.erb

@@ -0,0 +1,5 @@
+# -*- encoding : utf-8 -*-
+
+describe Card::Set::<%= set_pattern.camelize %>::<%= anchors.map(&:camelize).join('::') %> do
+
+end

data/lib/generators/card/set/templates/set_template.erb

@@ -0,0 +1 @@
+

data/mod/01_core/chunk/include.rb

@@ -0,0 +1,85 @@
+# -*- encoding : utf-8 -*-
+
+require_dependency File.expand_path( '../reference', __FILE__ )
+
+module Card::Chunk
+  class Include < Reference
+    cattr_reader :options
+    @@options = ::Set.new [ :inc_name, :inc_syntax, :view, :items, :type, :size, :title, :hide, :show, :structure ]
+    attr_reader :options
+
+    Card::Chunk.register_class self, {
+      :prefix_re => '\\{\\{',
+      :full_re   =>  /^\{\{([^\}]*)\}\}/,
+      :idx_char  => '{'
+    }
+
+    def interpret match, content
+      in_brackets = strip_tags match[1]
+#      warn "in_brackets = #{in_brackets}"
+      name, @opt_lists = in_brackets.split '|', 2
+      name = name.to_s.strip
+      result = case name
+        when /^\#\#/ ; '' # invisible comment
+        when /^\#/   ; "<!-- #{CGI.escapeHTML in_brackets} -->"
+#        when /^\s*$/ ; '' # no name
+        else
+          @options = @opt_lists.to_s.split('|').reverse.inject(nil) do |prev_level, level_options|
+            process_options level_options, prev_level
+          end || {}
+          @options.merge! :inc_name => name, :inc_syntax => in_brackets
+          @name = name
+        end
+
+      @process_chunk = result if !@name
+    end
+
+    def strip_tags string
+      #note: not using ActionView's strip_tags here because this needs to be super fast.
+      string.gsub /\<[^\>]*\>/, ''
+    end
+
+    def process_options list_string, items
+      hash = {}
+      style_hash = {}
+      hash[:items] = items unless items.nil?
+      Hash.new_from_semicolon_attr_list( list_string ).each do |key, value|
+        key = key.to_sym
+        if key==:item
+          hash[:items] ||= {}
+          hash[:items][:view] = value
+        elsif @@options.include? key
+          hash[key] = value
+        else
+          style_hash[key] = value
+        end
+      end
+
+      if !style_hash.empty?
+        hash[:style] = style_hash.map { |key, value| CGI.escapeHTML "#{key}:#{value};" } * ''
+      end
+      hash
+    end
+
+    def inspect
+      "<##{self.class}:n[#{@name}] p[#{@process_chunk}] txt:#{@text}>"
+    end
+
+    def process_chunk
+      return @process_chunk if @process_chunk
+
+      referee_name
+      if view = @options[:view]
+        view = view.to_sym
+      end
+
+      @processed = yield @options # this is not necessarily text, sometimes objects for json
+    end
+
+    def replace_reference old_name, new_name
+      replace_name_reference old_name, new_name
+      @text = "{{#{ [ @name.to_s, @opt_lists ].compact * '|' }}}"
+    end
+
+  end
+end

data/mod/01_core/chunk/link.rb

@@ -0,0 +1,87 @@
+# -*- encoding : utf-8 -*-
+
+require_dependency File.expand_path( '../reference', __FILE__ )
+
+module Card::Chunk
+  class Link < Reference
+    word = /\s*([^\]\|]+)\s*/
+    # Groups: $1, [$2]: [[$1]] or [[$1|$2]] or $3, $4: [$3][$4]
+    Card::Chunk.register_class self, {
+      :prefix_re => '\\[',
+      :full_re   => /^\[\[([^\]]+)\]\]/,
+      :idx_char  => '['
+    }
+
+    def interpret match, content
+      target, @link_text = if raw_syntax = match[1]
+        if i = divider_index( raw_syntax )  # [[ A | B ]]
+          [ raw_syntax[0..(i-1)], raw_syntax[(i+1)..-1] ]
+        else                                # [[ A ]]
+          [ raw_syntax, nil ]
+        end
+      end
+      
+      @link_text = objectify @link_text
+      if target =~ /\/|mailto:/
+        @explicit_link = objectify target
+      else
+        @name = target
+      end  
+    end
+
+    def divider_index string
+      #there's probably a better way to do the following.  point is to find the first pipe that's not inside an inclusion
+      
+      if string.index '|'
+        string_copy = "#{string}" # had to do this to create new string?!
+        string.scan /\{\{[^\}]*\}\}/ do |incl|
+          string_copy.gsub! incl, ('x'*incl.length)
+        end
+        string_copy.index '|'
+      end
+    end
+
+    def objectify raw
+      if raw
+        raw.strip!
+        if raw =~ /(^|[^\\])\{\{/
+          Card::Content.new raw, format
+        else
+          raw
+        end
+      end
+    end
+
+
+    def render_link
+      @link_text = render_obj @link_text
+      
+      if @explicit_link
+        @explicit_link = render_obj @explicit_link
+        format.web_link @explicit_link, :text=> @link_text
+      elsif @name
+        format.card_link referee_name, :text=>@link_text, :known=>referee_card.send_if(:known?)
+      end
+    end
+
+    def process_chunk
+      @process_chunk ||= render_link
+    end
+
+    def inspect
+      "<##{self.class}:e[#{@explicit_link}]n[#{@name}]l[#{@link_text}] p[#{@process_chunk}] txt:#{@text}>"
+    end
+
+    def replace_reference old_name, new_name
+      replace_name_reference old_name, new_name
+
+      if Card::Content===@link_text
+        @link_text.find_chunks(Card::Chunk::Reference).each { |chunk| chunk.replace_reference old_name, new_name }
+      else
+        @link_text = new_name if old_name.to_name == @link_text
+      end
+      
+      @text = @link_text.nil? ? "[[#{referee_name.to_s}]]" : "[[#{referee_name.to_s}|#{@link_text}]]"
+    end
+  end
+end

data/mod/01_core/chunk/literal.rb

@@ -0,0 +1,24 @@
+# -*- encoding : utf-8 -*-
+
+# These are basic chunks that have a pattern and can be protected.
+# They are used by rendering process to prevent wiki rendering
+# occuring within literal areas such as <code> and <pre> blocks
+# and within HTML tags.
+module Card::Chunk
+  class EscapedLiteral < Abstract
+    FULL_RE = { '[' => /^\\\[\[[^\]]*\]\]/, '{' => /^\\\{\{[^\}]*\}\}/ }
+    Card::Chunk.register_class self, {
+      :prefix_re => '\\\\(?:\\[\\[|\\{\\{)',
+      :idx_char  => '\\'
+    }
+
+    def self.full_re prefix
+      re = FULL_RE[ prefix[1,1] ]
+    end
+
+    def interpret match, content
+      @process_chunk = match[0].sub(/^\\(.)/, "<span>\\1</span>")
+    end
+  end
+
+end

data/mod/01_core/chunk/reference.rb

@@ -0,0 +1,53 @@
+# -*- encoding : utf-8 -*-
+module Card::Chunk
+  class Reference < Abstract
+    attr_accessor :referee_name, :name
+
+    def referee_name
+      return if name.nil?
+      
+      @referee_name ||= begin
+        rendered_name = render_obj( name )
+        ref_card = case rendered_name
+        when /^\~(\d+)$/ # get by id
+          Card.fetch $1.to_i 
+        when /^\:(\w+)$/ # get by codename
+          Card.fetch $1.to_sym
+        end
+        if ref_card
+          ref_card.cardname
+        else
+          rendered_name.to_name
+        end
+      end
+      @referee_name = @referee_name.to_absolute(card.cardname).to_name
+    end
+
+    def referee_card
+      @referee_card ||= referee_name && Card.fetch( referee_name )
+    end
+    def referee_id
+      referee_card and referee_card.id
+    end
+
+    def replace_name_reference old_name, new_name
+      #warn "ref rnr #{inspect}, #{old_name}, #{new_name}"
+      @referee_card = @referee_name = nil
+      if Card::Content===name
+        name.find_chunks(Chunk::Reference).each { |chunk| chunk.replace_reference old_name, new_name }
+      else
+        @name = name.to_name.replace_part( old_name, new_name )
+      end
+    end
+    
+    def render_obj raw
+      if format && Card::Content===raw
+        format.card.references_expired = nil # don't love this; this is to keep from running update_references again
+        format.process_content raw
+      else
+        raw
+      end
+    end
+  end
+end
+