client_pages 0.0.2.alpha → 0.0.3.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 82904ac8341a7933e443e28906539c0e6f70e4da
-  data.tar.gz: 3d68be7fa246b1de11e4fee95750293e8bc0dfc8
+  metadata.gz: 651585c4dbeab42b84039c22aec54878b9f54426
+  data.tar.gz: df24efef446ba402721bf025295c0d978103dfd4
 SHA512:
-  metadata.gz: c273aa8f22b87c4b49e91f69127955ebaa0f85bd5f00989ddb0e2df70e1b3a61222887e501da64174d0986f34aff7fbe2226a8860ceb28012843fb9f7e94c178
-  data.tar.gz: c9d878fa73bf1b6962d50edfbda5c34092c6cdb806e67af0f9ec1ab25dedced2319f0831755de10cacca9020bf67b6dfe6e6fd81afffd2ad6c1f79d588273415
+  metadata.gz: 4f859d580c6ba704bec2fd9dcbb05baa4208bae91c355c6c8618f55d9a46ce32bceeaa0b4bab8622ca4b2279dcd7a6d577908a33bfc664e39e4b391b122071d6
+  data.tar.gz: 9812ecd03067ce9907d6fe3d0c1fd58d6625877fb1f2d44a67af5ec5535e373187abc1aa4313cb82db0184968cf472ffa59c32d0d4b14a459988942aecad49f2

data/.gitignore

@@ -17,4 +17,4 @@ test/tmp
 test/version_tmp
 tmp
 .rvmrc
-.rubocop.yml
+*.notes

data/.rubocop.yml

@@ -0,0 +1,74 @@
+AllCops:
+  Includes:
+    - 'Gemfile'
+    - 'Rakefile'
+
+ParameterLists:
+  Max: 3
+  CountKeywordArgs: true
+
+BlockNesting:
+  Max: 3
+
+HashSyntax:
+  Enabled: true
+
+StringLiterals:
+  Enabled: true
+
+Void:
+  Enabled: true
+
+LineLength:
+  Enabled: true
+  Max: 115
+
+CyclomaticComplexity:
+  Max: 7
+
+SpaceInsideHashLiteralBraces:
+  Enabled: true
+
+AlignParameters:
+  Enabled: true
+
+Blocks:
+  Enabled: false
+
+SpaceAroundEqualsInParameterDefault:
+  Enabled: false
+
+NumericLiterals:
+  Enabled: true
+
+SpaceInsideBrackets:
+  Enabled: true
+
+WordArray:
+  Enabled: true
+
+Lambda:
+  Enabled: true
+
+RegexpLiteral:
+  Enabled: true
+
+ConstantName:
+  Enabled: false
+
+TrivialAccessors:
+  Enabled: true
+  ExactNameMatch: true
+
+Alias:
+  Enabled: true
+
+Loop:
+  Enabled: true
+
+AndOr:
+  Enabled: false
+
+Documentation:
+  Enabled: false
+

data/README.md

@@ -1,47 +1,19 @@
 # ClientPages
 
-##### Todo:
-
-- extract single files and responsibilites
-- set resonable defaults, like enable table, and auto link.
-- fallback option? => error handling if no such file?
-- yaml content?
-- builder#wrap needs conditional and multi wrap + nested wrap
-- builder methoden vereinheitlichen
-  - modify :tag, with: {}, if: {}|->|?
-  - wrap :tag, with: {}, if: {}|->|?
-  - replace :tag, with: {}, if: {}|->|?
-  - c.method &block
-- builder defaults? (all :p will get class x)
-  - maybe adjust ```render_content``` with additional parameter, like simple_form does
-  - defaults: :table_settings => will be stored somewhere as a block
-- test new configs! (.remote, .remote_content_path, .content_path, .caching, .fallback, .i18n)
-- railtie
-- i18n support content/de/something, content/en/something
-- extract classes
-- oauth dropbox?
-- logger!?
-- back up command/rake task, content:pull
-  nimmt alle local content files und überschreibt diese mit denen der remote version (wenn verfügbar)
-- travis
-- codeclimate
-
-
-if defined?(Rails)
-  html_safe all the things
-
 ---
+Ever heard: **"can we change the text on the homepage by ourself?"**
 
-# Ideas/Notes:
-
----
+___
 
-with client_pages you can separate your content from html markup and css styles.
+with client_pages you can separate your content from html markup and css styles,
+by extracting it to simple markdown files.
 
 use it for small content parts of your app which need to be updated regulary by someone
 or outsource all your content together, it's up to you.
 
-**Ever heard "can we change the text on page x?"**
+"the principle is really easy. at the place where you call render_content(:foo),
+the renderer will grap the markdown file content/foo.md and render it as html.
+by passing a block to render_content the generated markup can be modified."
 
 the main benefit of doing this: anybody can change the content, without the need for an admin backend and stuff like this.
 just make it possible for them to edit the files.
@@ -70,6 +42,8 @@ we can accomplish all that by just giving the ```render_content(:file)``` method
 and tell the content builder to do that for you.
 **insert haml here**
 
+if configured ```render_content``` work with raw markdown, instead of a file name.
+
 this way, you can add a lot of behaivour by leaving your markdown content just as content with raw structure,
 and the main markup and styling stays in your views.
 
@@ -139,8 +113,6 @@ sinatra?
     c.remote_content_path = 'https://dl.dropboxusercontent.com/u/363312/rackedy_rack'
     c.content_path = 'content'
     c.caching = true
-    c.fallback = false
-    c.i18n = false
     c.render_options = {
       hard_wrap: true,
       with_toc_data: false,
@@ -164,17 +136,15 @@ sinatra?
   hm, or where is the problem? ```render_content("#{my_locale}/posts/index")```
 
 ### caching
-  the current implementation it the easiest way to do this.
-  it's really simple and lives as long as the process runs.
-  it can not be shared between processes
+  the current implementation it the easiest way to do something like caching.
+  it's really simple and lives as long as the process runs, as it's nothing more than a hash that doesn't get persistet.
+  so it can not be shared between processes.
   and because one of the [hard things in Computer Science](http://martinfowler.com/bliki/TwoHardThings.html) is _cache invalidation_
-  you can flush the cache also at runtime either complete or by passing a file_path (which is the cache key):
-
-  you can accomplish this with some additional code.
+  you can flush the cache also at runtime with
 
-  ```code follows```
+  ```cache.clear```
 
-  or run the corresponding command. (not implemented yet)
+  So if your're curious about caching, you should take care of that by yourself and cache the complete render_content block for example.
 
 ### commands
   - downloader!!!
@@ -184,9 +154,12 @@ sinatra?
 
 ## Contributing
 
+Contributions are always welcome! Doesn't matter if you fix just a typo, add some documentation/tests or refactor hole parts of the code.
+As this gem is in early development, there are a lot of low hanging fruits.
+
 + Fork it
 + Change it
 + Test it
 + Commit it
 + Push it
-+ Pull Request
++ Pull Request it

data/Rakefile

@@ -2,4 +2,11 @@ require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
-task default: :spec
+task default: :metrics
+
+desc 'run some metric tools'
+task metrics: :spec do
+  system('rubocop')
+  puts
+  system('flog lib')
+end

data/client_pages.gemspec

@@ -30,5 +30,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'webmock', '~> 1.17.3'
   s.add_development_dependency 'pry-plus', '~> 1.0.0'
   s.add_development_dependency 'rubocop', '~> 0.18.1'
+  s.add_development_dependency 'flog', '~> 4.2.0'
   s.add_development_dependency 'simplecov', '~> 0.8.2'
 end

data/lib/client_pages/configuration.rb

@@ -0,0 +1,29 @@
+module ClientPages
+  class Configuration
+    attr_accessor :content_path, :remote, :remote_content_path, :caching, :fallback, :i18n, :raw_markdown
+    attr_reader :render_options, :markdown_extensions
+
+    def initialize
+      @content_path = 'content'
+      @render_options = {}
+      @markdown_extensions = {}
+    end
+
+    def render_options=(options)
+      @render_options.merge!(options)
+    end
+
+    def markdown_extensions=(options)
+      @markdown_extensions.merge!(options)
+    end
+
+    def to_hash
+      # TODO: instance vars get
+      {
+        content_path: content_path,
+        render_options: render_options,
+        markdown_extensions: markdown_extensions
+      }
+    end
+  end
+end

data/lib/client_pages/markdown_content/content_builder.rb

@@ -0,0 +1,64 @@
+module ClientPages
+  module MarkdownContent
+    class ContentBuilder
+      attr_accessor :html
+
+      def initialize(html)
+        @html = html
+      end
+
+      def modify(tag, options={})
+        html_lines do |line|
+          conditions(tag, line, options[:if]) do
+            match(tag, line, :open) { |open_tag| open_tag.gsub(/>/, "#{attributes(options)}>") }
+          end
+        end
+      end
+
+      def wrap(tag, wrapper, options={})
+        html_lines do |line|
+          conditions(tag, line, options[:if]) do
+            line = match(tag, line, :open) { |rest| "<#{wrapper.to_s + attributes(options)}>" + rest }
+            line = match(tag, line, :close) { |rest| rest + "</#{wrapper}>" }
+          end
+        end
+      end
+
+      def replace(tag, new_tag, options={})
+        html_lines do |line|
+          conditions(tag, line, options[:if]) do
+            line = match(tag, line, :open) { |open_tag| "<#{new_tag.to_s + attributes(options)}>" }
+            line = match(tag, line, :close) { |closing_tag| "</#{new_tag}>" }
+          end
+        end
+      end
+
+      private
+
+      def match(tag, line, state)
+        Matcher.new(tag, line).find(state) { |match| yield match }
+      end
+
+      def conditions(tag, line, condition)
+        return yield if condition.nil?
+        if condition.respond_to?(:call) && condition.call(Matcher.new(tag, line))
+          yield
+        elsif condition.is_a?(Hash) && Matcher.new(tag, line).match_all?(condition)
+          yield
+        elsif condition == true
+          yield
+        else
+          line
+        end
+      end
+
+      def html_lines(&block)
+        self.html = html.lines.map { |line| yield line }.join
+      end
+
+      def attributes(options)
+        options.fetch(:with, {}).map { |k, v| " #{k}=\"#{v}\"" }.join
+      end
+    end
+  end
+end

data/lib/client_pages/markdown_content/renderer.rb

@@ -0,0 +1,84 @@
+module ClientPages
+  module MarkdownContent
+    class Renderer
+      class << self
+        def render_content(file, options = {})
+          html = new(file, options).html
+          block_given? ? yield(ContentBuilder.new(html)) : html.strip
+        rescue OpenURI::HTTPError
+          "404: could not find '#{file}'"
+        rescue Errno::ENOENT
+          "No such file or directory - #{file}"
+        rescue SocketError
+          'Error: content_path not available'
+        end
+      end
+
+      attr_reader :file, :options
+
+      def initialize(file, options = {})
+        @file, @options = file, options
+      end
+
+      def html
+        html = html_from_markdown
+        html = template.call(ContentBuilder.new(html)) if options.key?(:template)
+        html
+      end
+
+      private
+
+      def html_renderer
+        Redcarpet::Render::HTML.new(config.render_options)
+      end
+
+      def extensions
+        config.markdown_extensions.merge(options.key?(:extensions) ? options[:extensions] : {})
+      end
+
+      def html_from_markdown
+        Redcarpet::Markdown.new(html_renderer, extensions).render(markdown)
+      end
+
+      def template
+        ClientPages.template[options[:template]]
+      end
+
+      def markdown
+        raw? ? file : read_file
+      end
+
+      def url
+        "#{content_path}/#{file}.md"
+      end
+
+      def read_file
+        if caching?
+          cache.fetch(url) { cache[url] = open(url).read }
+        else
+          open(url).read
+        end
+      end
+
+      def content_path
+        config.remote ? config.remote_content_path : config.content_path
+      end
+
+      def raw?
+        config.raw_markdown || options[:raw]
+      end
+
+      def caching?
+        config.caching
+      end
+
+      def config
+        ClientPages.config
+      end
+
+      def cache
+        ClientPages.cache
+      end
+    end
+  end
+end

data/lib/client_pages/matcher.rb

@@ -0,0 +1,39 @@
+module ClientPages
+  class Matcher
+    attr_accessor :tag, :line
+
+    def initialize(tag, line)
+      @tag, @line = tag, line
+    end
+
+    def match?(attribute, match)
+      !!line.match(/<#{tag}[^>]*#{attribute}="#{match}"/i)
+    end
+
+    def match_all?(attributes)
+      attributes.keys.all? { |key| match?(key, attributes[key]) }
+    end
+
+    def match_any?(attribute, match)
+      !!line.match(/#{attribute}="#{match}"/i)
+    end
+
+    def includes?(pattern)
+      !!line.match(pattern)
+    end
+
+    def find(type)
+      if block_given? && includes?(tag_pattern[type])
+        line.gsub(tag_pattern[type]) { |match| yield match }
+      else
+        line
+      end
+    end
+
+    private
+
+    def tag_pattern
+      { open: /<#{tag}[^>]*>/, close: /<\/#{tag}[^>]*>/ }
+    end
+  end
+end

data/lib/client_pages/template.rb

@@ -0,0 +1,7 @@
+module ClientPages
+  class Template
+    def set(name, &settings)
+      ClientPages.template[name] = Proc.new(&settings)
+    end
+  end
+end

data/lib/client_pages/version.rb

@@ -1,3 +1,3 @@
 module ClientPages
-  VERSION = '0.0.2.alpha'
+  VERSION = '0.0.3.beta'
 end

data/lib/client_pages.rb

@@ -4,6 +4,15 @@ require 'open-uri'
 require 'redcarpet'
 
 module ClientPages
+  autoload :Matcher, 'client_pages/matcher'
+  autoload :Template, 'client_pages/template'
+  autoload :Configuration, 'client_pages/configuration'
+
+  module MarkdownContent
+    autoload :ContentBuilder, 'client_pages/markdown_content/content_builder'
+    autoload :Renderer, 'client_pages/markdown_content/renderer'
+  end
+
   class << self
     attr_accessor :configuration
 
@@ -12,207 +21,16 @@ module ClientPages
       block_given? ? yield(configuration) : configuration
     end
 
-    def cache
-      @cache ||= {}
-    end
-
-    def clear_cache(key=nil)
-      if key
-        cache.delete(key)
-        "cache cleared: #{key}"
-      else
-        cache.clear
-        'cache cleared'
-      end
-    end
-  end
-
-  module MarkdownContent
-    class MarkdownContentRenderer
-      include ClientPages::MarkdownContent
-    end
-
-    def self.render_content(file, options={})
-      MarkdownContentRenderer.new.render_content(file, options)
-    end
-
-    class Matcher
-      attr_accessor :tag, :line
-
-      def initialize(tag, line)
-        @tag, @line = tag, line
-      end
-
-      def exact_match?(attribute, match)
-        !!line.match(/<#{tag}[^>]*#{attribute}="#{match}"/i)
-      end
-
-      def attr?(attribute, match)
-        !!line.match(/#{attribute}="#{match}"/i)
-      end
-
-      def match?(pattern)
-        !!line.match(pattern)
-      end
-
-      def find(type)
-        pattern = { opening: /<#{tag}[^>]*>/, closing: /<\/#{tag}[^>]*>/ }[type]
-        if block_given? && !!line.match(pattern)
-          line.gsub(pattern) { |match| yield match }
-        else
-          line
-        end
-      end
-    end
-
-    class ContentBuilder
-      attr_accessor :html
-
-      def initialize(html)
-        @html = html
-      end
-
-      def modify(tag, options={}, conditions=true)
-        if conditions.respond_to? :call
-          html_lines do |line|
-            if conditions.call(Matcher.new(tag, line))
-              set_options_for_tags_per_line(options, tag, line)
-            else
-              line
-            end
-          end
-        elsif conditions.is_a?(Hash)
-          html_lines do |line|
-            if conditions.keys.all? { |key| Matcher.new(tag, line).exact_match?(key, conditions[key]) }
-              set_options_for_tags_per_line(options, tag, line)
-            else
-              line
-            end
-          end
-        elsif !!conditions
-          set_options_for_tags(options, tag)
-        end
-        self.html
-      end
-
-      def wrap(tag, options={})
-        html_lines do |line|
-          line = Matcher.new(tag, line).find(:opening) do |match|
-            "<#{options[:wrapper]} class=\"#{options[:class]}\">#{match}"
-          end
-          line = Matcher.new(tag, line).find(:closing) do |match|
-            "#{match}</#{options[:wrapper]}>"
-          end
-        end
-      end
-
-      def replace(tag, new_tag, options={})
-        html_lines do |line|
-          line = Matcher.new(tag, line).find(:opening) do |match|
-            "<#{new_tag} class=\"#{options[:class]}\">"
-          end
-          line = Matcher.new(tag, line).find(:closing) do |match|
-            "</#{new_tag}>"
-          end
-        end
-      end # ContentBuilder
-
-      private
-
-      def html_lines(&block)
-        self.html = html.lines.map { |line| yield line }.join
-      end
-
-      def set_options_for_tags(options, tag)
-        html_lines { |line| set_options_for_tags_per_line(options, tag, line) }
-      end
-
-      def set_options_for_tags_per_line(options, tag, line)
-        options.each { |k, v| line = line.gsub(/<#{tag}/, "<#{tag} #{k}=\"#{v}\"") }
-        line
-      end
-    end
-
-    def render_content(file, options = markdown_extensions)
-      html = Redcarpet::Markdown.new(html_renderer, options).render(markdown(file))
-      if block_given?
-        yield(ContentBuilder.new(html))
-      else
-        html.strip
-      end
-    rescue OpenURI::HTTPError
-      "404: could not find '#{file}'"
-    rescue Errno::ENOENT => e
-      e.message
-    rescue SocketError
-      'Error: content_path not available'
+    def template
+      @template ||= {}
     end
 
-    private
-
-    def html_renderer
-      Redcarpet::Render::HTML.new(config.render_options)
-    end
-
-    def markdown_extensions
-      config.markdown_extensions
-    end
-
-    def markdown(file)
-      url  = "#{content_path}/#{file}.md"
-      if caching?
-        cache.fetch(url) { cache[url] = open(url).read }
-      else
-        open(url).read
-      end
-    end
-
-    def config
-      ClientPages.config
+    def templates(&block)
+      yield Template.new
     end
 
     def cache
-      ClientPages.cache
-    end
-
-    def caching?
-      config.caching
-    end
-
-    def remote?
-      config.remote
-    end
-
-    def content_path
-      remote? ? config.remote_content_path : config.content_path
-    end
-  end
-
-  class Configuration
-    attr_accessor :content_path, :remote, :remote_content_path, :caching, :fallback, :i18n
-    attr_reader :render_options, :markdown_extensions
-
-    def initialize
-      @content_path = 'content'
-      @render_options = {}
-      @markdown_extensions = {}
-    end
-
-    def render_options=(options)
-      @render_options.merge!(options)
-    end
-
-    def markdown_extensions=(options)
-      @markdown_extensions.merge!(options)
-    end
-
-    def to_hash
-      # TODO: instance vars get
-      {
-        content_path: content_path,
-        render_options: render_options,
-        markdown_extensions: markdown_extensions
-      }
+      @cache ||= {}
     end
   end
 end

data/spec/fixtures/foo/bar.md

@@ -0,0 +1,3 @@
+# foo
+
+bar