lei 0.2.0

data/example/controllers/content.rb

@@ -0,0 +1,67 @@
+puts "\tController: Content"
+
+class ContentController < Sinatra::Base
+    
+    set :content_dir, "#{$root}/content"
+    set :stylesheet, "content"
+    set :public_folder, $assets_root
+    set :views, $views
+
+    get "/" do
+        content = ContentHelpers.get_content(settings.content_dir)
+        redirect 404 if content.length == 0
+
+        url = request.url
+
+        ContentHelpers.time_sort(content)
+        contentParts = ContentHelpers.paginate(content, params, url)
+
+        slim :content, locals: {
+            **contentParts,
+            style: ContentHelpers.load_css(settings.stylesheet),
+            title: "Posts",
+            url: url
+        }
+    end
+
+    get "/post/:title" do
+        title = params["title"]
+        redirect 404 if title.nil? || title.length == 0
+
+        content = ContentHelpers.get_post(settings.content_dir, title)
+        redirect 404 if content.length != 1
+
+        parsed_title = title.split("-").join(" ")
+
+        slim :post, locals: {
+            content: ContentHelpers.parse_md(content)[0],
+            style: ContentHelpers.load_css(settings.stylesheet),
+            title: parsed_title,
+            url: request.url
+        }
+    end
+
+    get "/filter" do
+        content = ContentHelpers.get_content(settings.content_dir)
+
+        ContentHelpers.filter_content(content, params)
+        redirect 404 if content.length == 0
+
+        url = request.url
+
+        ContentHelpers.time_sort(content)
+        contentParts = ContentHelpers.paginate(content, params, url)
+
+        slim :search_results, locals: {
+            **contentParts,
+            style: ContentHelpers.load_css(settings.stylesheet),
+            title: "Filtered Results",
+            url: url
+        }
+    end
+
+    not_found do
+        slim :notfound, locals: { **ContentHelpers.nf_404, url: request.url }
+    end
+
+end

data/example/controllers/custom.rb

@@ -0,0 +1,33 @@
+puts "\tController: Custom"
+
+class CustomController < Sinatra::Base
+    
+    set :public_folder, $assets_root
+    set :views, $views
+
+    routes = YAML.load_file("#{$root}/customlist.yml")
+
+    routes.each do |route|
+        name = route["name"]
+        path = route["path"]
+        puts "\t\t#{path}: #{name}"
+
+        get path do
+            folder = "#{$root}/#{name}"
+
+            content = route["content"].map { |section| "#{folder}/#{section}" }
+
+            slim name.to_sym, locals: {
+                content: ContentHelpers.parse_md(content),
+                style: ContentHelpers.load_css(name),
+                title: route["title"],
+                url: request.url
+            }
+        end
+    end
+
+    not_found do
+        slim :notfound, locals: { **ContentHelpers.nf_404, url: request.url }
+    end
+
+end

data/example/controllers/test.rb

@@ -0,0 +1,12 @@
+require "#{$root}/controllers/content"
+
+puts "\tController: Test"
+
+class TestController < ContentController
+    
+    set :content_dir, "#{$root}/test"
+    set :stylesheet, "content"
+    set :public_folder, $assets_root
+    set :views, $views
+
+end

data/example/helpers/content_helpers.rb

@@ -0,0 +1,131 @@
+puts "\tHelper: Content"
+
+require "redcarpet"
+
+module ContentHelpers
+
+    CARPET = Redcarpet::Markdown.new(
+        Redcarpet::Render::HTML.new({
+            hard_wrap: true,
+            highlight: true
+        })
+    )
+
+    def self.filter_content(content, params)
+        term = params["term"]
+        if !term.nil? && term.length > 2
+            content.reject! do |c|
+                post = `cat #{c}`
+                !post.match?(Regexp.new(term, true))
+            end
+        end
+    
+        yyyy = params["year"]
+        if !yyyy.nil? && yyyy.length == 4
+            content.reject! { |c| File::Stat.new(c).mtime.year != yyyy.to_i }
+        end
+    
+        mm = params["month"]
+        if !mm.nil? && mm.length == 2
+            content.reject! { |c| File::Stat.new(c).mtime.month != mm.to_i }
+        end
+    
+        dd = params["day"]
+        if !dd.nil? && dd.length == 2
+            content.reject! { |c| File::Stat.new(c).mtime.day != dd.to_i }
+        end
+    end
+    
+    def self.get_content(contentDir)
+        all = Dir.glob("#{contentDir}/*.md")
+        classified = YAML.load_file($banlist)
+    
+        all - classified
+    end
+
+    def self.get_post(contentDir, title)
+        content = self.get_content(contentDir)
+
+        post = "#{contentDir}/#{title}.md"
+
+        content.include?(post) ? [ post ] : []
+    end
+
+    <<~load_css
+        This function reads and returns the contents of a CSS file as a string.
+        Its return value gets stored in a variable for ease of interpolation in
+        templates.
+    load_css
+
+    def self.load_css(filename)
+        `cat #{$style_root}/#{filename}.css`
+    end
+
+    def self.mp_eu(path, params, replacement)
+        newParams = {}
+        params.each { |k, v| newParams[k] = v }
+        replacement.each { |i, j| newParams[i] = j }
+        encoded = URI.encode_www_form(newParams)
+        
+        "#{path}?#{encoded}"
+    end
+
+    def self.nf_404
+        {
+            title: "404: Not Found",
+            style: self.load_css("notfound")
+        }
+    end
+    
+    def self.paginate(content, params, url)
+        pageParam = params["page"].to_i
+    
+        page = pageParam != 0 ? pageParam : 1
+        pages = (content.length / 5.0).ceil
+        
+        firstIndex = (page - 1) * 5
+        lastIndex = page * 5 - 1
+    
+        path = URI(url).path
+        pageUrls = [ nil, nil, nil, nil ]
+        
+        if page > 1
+            pageUrls[0] = self.mp_eu(path, params, { "page" => "1" })
+            
+            prev = (page - 1).to_s
+            pageUrls[1] = self.mp_eu(path, params, { "page" => prev })
+        end
+    
+        if page < pages
+            foll = (page + 1).to_s
+            pageUrls[2] = self.mp_eu(path, params, { "page" => foll })
+
+            pageUrls[3] = self.mp_eu(path, params, { "page" => pages.to_s })
+        end
+    
+        {
+            content: self.parse_md(content[firstIndex..lastIndex]),
+            page: page,
+            pages: pages,
+            pageUrls: pageUrls
+        }
+    end
+
+    <<~parse_md
+        This function takes a list of filenames, reads their contents, and
+        utilizes the Redcarpet gem to parse them into HTML.
+    parse_md
+
+    def self.parse_md(filenames)
+        filenames.map do |filename|
+            content = `cat #{filename}`
+            CARPET.render(content)
+        end
+    end
+    
+    def self.time_sort(content)
+        content.sort_by! { |c| File::Stat.new(c).mtime }
+        content.reverse!
+    end
+
+end

data/example/helpers/global_utils.rb

@@ -0,0 +1,44 @@
+puts "\tHelper: Global Utilities"
+
+require "dotenv"
+
+module GlobalUtils
+
+    def self.declare_globals
+        puts "\t\t--- Loading Environment Variables ---"
+
+        Dotenv.load
+
+        puts "\t\t--- Declaring Globals ---"
+        
+        $assets_root = "#{$root}/static"
+        $style_root = "#{$assets_root}/styles"
+        $views = "#{$root}/views"
+
+        $banlist = "#{$root}/banlist.yml"
+
+        <<~AMP
+            AMP Static Header Parts, as of 15 APR 2018:
+            https://www.ampproject.org/docs/fundamentals/spec
+
+            AMP Boilerplate, as of 15 APR 2018:
+            https://www.ampproject.org/docs/fundamentals/spec/amp-boilerplate
+
+            amp-bind, as of 15 APR 2018:
+            https://www.ampproject.org/docs/reference/components/amp-bind
+        AMP
+
+        $amp_static_header = <<~HEADER
+            <meta charset="utf-8">
+            <meta name="viewport" content="width=device-width,minimum-scale=1,initial-scale=1">
+            <script async src="https://cdn.ampproject.org/v0.js"></script>
+        HEADER
+
+        $amp_boiler = <<~BOILER
+            <style amp-boilerplate>body{-webkit-animation:-amp-start 8s steps(1,end) 0s 1 normal both;-moz-animation:-amp-start 8s steps(1,end) 0s 1 normal both;-ms-animation:-amp-start 8s steps(1,end) 0s 1 normal both;animation:-amp-start 8s steps(1,end) 0s 1 normal both}@-webkit-keyframes -amp-start{from{visibility:hidden}to{visibility:visible}}@-moz-keyframes -amp-start{from{visibility:hidden}to{visibility:visible}}@-ms-keyframes -amp-start{from{visibility:hidden}to{visibility:visible}}@-o-keyframes -amp-start{from{visibility:hidden}to{visibility:visible}}@keyframes -amp-start{from{visibility:hidden}to{visibility:visible}}</style><noscript><style amp-boilerplate>body{-webkit-animation:none;-moz-animation:none;-ms-animation:none;animation:none}</style></noscript>
+        BOILER
+
+        $amp_bind = "<script async custom-element=\"amp-bind\" src=\"https://cdn.ampproject.org/v0/amp-bind-0.1.js\"></script>"
+    end
+    
+end

data/example/spec/spec_helper.rb

@@ -0,0 +1,100 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/example/spec/test/content_helper_spec.rb

@@ -0,0 +1,176 @@
+require "yaml"
+
+root = File.dirname(__FILE__)
+fixtures = "#{root}/../fixtures"
+$banlist = "#{fixtures}/banlist.yml"
+$style_root = fixtures
+
+require_relative "../../helpers/content_helpers"
+
+RSpec.describe "Tests Module: ContentHelpers" do
+
+    content = ContentHelpers.get_content(fixtures)
+
+    it "Tests variable $banlist: Verifies exclusion" do
+        expect(content.length).not_to eq 7
+        expect(content).not_to include "#{fixtures}/md-2.md"
+    end
+
+    it "Tests method time_sort: Correctly sorts by mtime" do
+        ContentHelpers.time_sort(content)
+
+        expect(content.first).to eq "#{fixtures}/md-1.md"
+        expect(content.last).to eq "#{fixtures}/md-3.md"
+    end
+
+    just6 = []
+    for i in 1..7
+        just6 << "#{fixtures}/md-#{i}.md" if i != 2
+    end
+    ContentHelpers.time_sort(just6)
+
+    it "Tests method get_content: Correctly retrieves content" do
+        expect(content.length).to eq 6
+        expect(content).to eq just6
+    end
+
+    it "Tests method get_post: Correctly retrieves post" do
+        post = ContentHelpers.get_post(fixtures, "md-4")
+        ContentHelpers.time_sort(post)
+
+        expect(post.length).to eq 1
+        expect(post).to eq [ "#{fixtures}/md-4.md" ]
+    end
+
+    path = "https://www.testDomain.com/fake"
+
+    it "Tests method mp_eu: Correctly adds a param" do
+        params = { "mode" => "test" }
+        newParams = { "action" => "add" }
+        newUrl = ContentHelpers.mp_eu(path, params, newParams)
+
+        expect(newUrl).not_to eq path
+        expect(newUrl).not_to eq "#{path}?mode=test"
+        expect(newUrl).to eq "#{path}?mode=test&action=add"
+    end
+
+    it "Tests method mp_eu: Correctly replaces a param" do
+        params = { "action" => "add", "mode" => "test" }
+        newParams = { "action" => "remove" }
+        newUrl = ContentHelpers.mp_eu(path, params, newParams)
+
+        expect(newUrl).not_to eq "#{path}?action=add&mode=test"
+        expect(newUrl).to eq "#{path}?action=remove&mode=test"
+    end
+
+    it "Tests method paginate: Correctly retrieves first page" do
+        params = {}
+        paginated = ContentHelpers.paginate(just6, params, path)
+
+        expect(paginated[:page]).to eq 1
+        expect(paginated[:pages]).to eq 2
+        expect(paginated[:content].length).to eq 5
+        expect(paginated[:pageUrls]).to eq [
+            nil,
+            nil,
+            "/fake?page=2",
+            "/fake?page=2"
+        ]
+
+        params2 = { "page" => "1" }
+        paginated2 = ContentHelpers.paginate(just6, params2, path)
+
+        expect(paginated2[:page]).to eq 1
+        expect(paginated2[:pages]).to eq 2
+        expect(paginated2[:content].length).to eq 5
+        expect(paginated2[:pageUrls]).to eq [
+            nil,
+            nil,
+            "/fake?page=2",
+            "/fake?page=2"
+        ]
+    end
+
+    it "Tests method paginate: Correctly retrieves second page" do
+        params = { "page" => "2" }
+        paginated = ContentHelpers.paginate(just6, params, path)
+
+        expect(paginated[:page]).to eq 2
+        expect(paginated[:pages]).to eq 2
+        expect(paginated[:content].length).to eq 1
+        expect(paginated[:pageUrls]).to eq [
+            "/fake?page=1",
+            "/fake?page=1",
+            nil,
+            nil
+        ]
+    end
+
+    it "Tests method filter_content: Correctly filters on term" do
+        params = { "term" => "third" }
+        filtered = just6.clone
+        ContentHelpers.filter_content(filtered, params)
+
+        expect(filtered.length).to eq 1
+        expect(filtered[0]).to eq "#{fixtures}/md-3.md"
+    end
+
+    it "Tests method filter_content: Correctly filters on year" do
+        params = { "year" => "2018" }
+        filtered = just6.clone
+        ContentHelpers.filter_content(filtered, params)
+
+        expect(filtered.length).to eq 6
+
+        params2 = { "year" => "2017" }
+        ContentHelpers.filter_content(filtered, params2)
+
+        expect(filtered.length).to eq 0
+    end
+
+    it "Tests method filter_content: Correctly filters on month" do
+        params = { "year" => "2018", "month" => "05" }
+        filtered = just6.clone
+        ContentHelpers.filter_content(filtered, params)
+
+        expect(filtered.length).to eq 6
+
+        params2 = { "year" => "2018", "month" => "04" }
+        ContentHelpers.filter_content(filtered, params2)
+
+        expect(filtered.length).to eq 0
+    end
+
+    it "Tests method filter_content: Correctly filters on day" do
+        params = { "year" => "2018", "month" => "05", "day" => "03" }
+        filtered = just6.clone
+        ContentHelpers.filter_content(filtered, params)
+
+        expect(filtered.length).to eq 4
+
+        params2 = { "year" => "2018", "month" => "05", "day" => "10" }
+        filtered2 = just6.clone
+        ContentHelpers.filter_content(filtered2, params2)
+
+        expect(filtered2.length).to eq 1
+
+        params3 = { "year" => "2018", "month" => "05", "day" => "04" }
+        filtered3 = just6.clone
+        ContentHelpers.filter_content(filtered3, params3)
+
+        expect(filtered3.length).to eq 1
+    end
+
+    it "Tests method parse_md: Correctly generates HTML from Markdown" do
+        converted = ContentHelpers.parse_md([ "#{fixtures}/md-1.md" ])
+
+        expect(converted[0]).to eq "<h1>Markdown 1st</h1>\n"
+    end
+
+    it "Tests method load_css: Correctly returns CSS file contents" do
+        processed = ContentHelpers.load_css("test")
+
+        expect(processed).to eq ".mock{display: none;}"
+    end
+
+end