mako_rss 0.1.0

data/lib/mako/feed_constructor.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Mako
+  class FeedConstructor
+    attr_reader :feed_url, :feed_data
+
+    def initialize(args)
+      @feed_url = args.fetch(:feed_url)
+      @feed_data = args.fetch(:feed_data)
+    end
+
+    # Parses raw XML feed and creates Feed and Article objects to
+    # be rendered. Returns false if feed cannot be parsed.
+    #
+    # @return [Feed]
+    def parse_and_create
+      parsed_feed = parse_feed
+      return false unless parsed_feed
+      feed = create_feed(parsed_feed)
+      create_articles(feed, parsed_feed)
+      feed
+    end
+
+    private
+
+    # @private
+    # Takes raw XML and parses it into a Feedjira::Feed object
+    #
+    # @return [Feedjira::Feed]
+    def parse_feed
+      Feedjira::Feed.parse(feed_data)
+    rescue Feedjira::NoParserAvailable
+      Mako.errors.add_error "Unable to parse #{feed_url}."
+      return false
+    end
+
+    # Creates new Mako::Feed object from the parsed Feedjira::Feed object
+    #
+    # @param [Feedjira::Feed]
+    # @return [Mako::Feed]
+    def create_feed(parsed_feed)
+      Feed.new(url: parsed_feed.url, title: parsed_feed.title)
+    end
+
+    # Creates new Mako::Article objects from the parsed Feedjira::Feed object
+    # if the source article was published within the last day. Adds the
+    # Mako::Article objects to the Mako::Feed object's articles attribute.
+    #
+    # @param [Mako::Feed] feed
+    # @param [Feedjira::Feed] parsed_feed
+    def create_articles(feed, parsed_feed)
+      parsed_feed.entries.each do |entry|
+        next unless entry.published >= (Time.now - 1.day).beginning_of_day
+        feed.articles << Article.new(title: entry.title,
+                                     published: entry.published,
+                                     summary: entry_summary(entry),
+                                     url: entry.url)
+      end
+    end
+
+    # Atom and RSS Feedjira::Feed objects have different names for the
+    # article body. Returns entry.content if Atom and entry.summary if
+    # RSS.
+    #
+    # @param [Feedjira::Feed]
+    # @return [String] an HTML string of the source article body
+    def entry_summary(entry)
+      entry.class.to_s.include?('Atom') ? entry.content : entry.summary
+    end
+  end
+end

data/lib/mako/feed_requester.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Mako
+  class FeedRequester
+    attr_reader :feed_url
+    attr_accessor :ok, :body
+
+    def initialize(args)
+      @ok = true
+      @body = ''
+      @feed_url = args.fetch(:feed_url)
+    end
+
+    # Performs HTTP request on the given feed_url. Sets the Mako::FeedRequester
+    # body attribute equal to the request body if successful and returns self.
+    # If the request fails, @ok is set to false.
+    #
+    # @return [Mako::FeedRequester]
+    def fetch
+      begin
+        request = Faraday.get(feed_url)
+      rescue Faraday::Error
+        Mako.errors.add_error "Could not complete request to #{feed_url}."
+        self.ok = false
+        return self
+      end
+      unless request.status == 200
+        Mako.errors.add_error "Request to #{feed_url} returned #{request.status}."
+        self.ok = false
+        return self
+      end
+      self.body = request.body
+      self
+    end
+
+    # Predicate method returning the value of @ok
+    #
+    # @return [Boolean]
+    def ok?
+      ok
+    end
+  end
+end

data/lib/mako/file_open_util.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module FileOpenUtil
+  # Opens and reads the passed in file. Thanks to the following article
+  # for explaining how to define a method on the included singleton class:
+  # https://6ftdan.com/allyourdev/2015/02/24/writing-methods-for-both-class-and-instance-levels/
+  #
+  # @param [String] resource the path to the resource
+  # @return [String] the opened resource
+  def self.included(base)
+    def base.load_resource(resource)
+      File.open(resource, 'rb', encoding: 'utf-8', &:read)
+    end
+  end
+
+  def load_resource(resource)
+    self.class.load_resource(resource)
+  end
+end

data/lib/mako/html_renderer.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Mako
+  class HTMLRenderer
+    include FileOpenUtil
+
+    attr_reader :template, :bound, :feed_template
+
+    def initialize(args)
+      @template = args.fetch(:template, File.expand_path(File.join('themes', "#{Mako.config.theme}.html.erb"), Dir.pwd))
+      @bound = args.fetch(:bound)
+      @feed_template = File.expand_path('../layouts/_feed_container.html.erb', __FILE__)
+    end
+
+    # Wrapper for ERB renderer. Creates new ERB instance with view template
+    # and renders it with binding from core.
+    #
+    # @return [String]
+    def render
+      ERB.new(load_resource(template)).result(bound.get_binding)
+    end
+
+    # Default file name for rendererd file.
+    #
+    # @return [String]
+    def file_path
+      'index.html'
+    end
+  end
+end

data/lib/mako/layouts/_feed_container.html.erb

@@ -0,0 +1,19 @@
+<section id="feed-container">
+  <% @feeds.each do |feed| %> 
+    <% if feed.articles.size > 0 %>
+      <section>
+        <header class="article-header">
+          <h1><a href="<%= feed.url %>"><%= h(feed.title) %></a></h1>
+        </header>
+        <% feed.articles.each do |article| %>
+          <article>
+            <h3><a href="<%= article.url %>"><%= h(article.title) %></a></h3>
+            <p class="meta"><%= article.formatted_published %></p>
+            <%= article.summary %>
+          </article>
+          <hr />
+        <% end %>
+      </section>
+    <% end %>
+  <% end %>
+</section>

data/lib/mako/mako_logger.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Mako
+  class MakoLogger < Logger
+    def initialize(logdev, shift_age = 0, shift_size = 1_048_576)
+      super(logdev, shift_age, shift_size)
+      self.formatter = proc do |_severity, _datetime, _progname, msg|
+        "#{msg}\n"
+      end
+    end
+  end
+end

data/lib/mako/sass_renderer.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Mako
+  class SassRenderer
+    include FileOpenUtil
+
+    attr_reader :template
+
+    def initialize(args)
+      @template = args.fetch(:template, File.expand_path(File.join('themes', "#{Mako.config.theme}.scss"), Dir.pwd))
+    end
+
+    # Wrapper for Sass::Engine.  Creates new Sass::Engine instance with main
+    # Sass file and renders it.
+    #
+    # @return [String]
+    def render
+      Sass::Engine.new(load_resource(template), syntax: :scss,
+                                                load_paths: [File.expand_path('themes/', Dir.pwd)],
+                                                style: :compressed).render
+    end
+
+    # Default file name for rendererd file.
+    #
+    # @return [String]
+    def file_path
+      'main.css'
+    end
+  end
+end

data/lib/mako/subscription_list_parser.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Mako
+  class SubscriptionListParser
+    include FileOpenUtil
+
+    attr_reader :list
+
+    def initialize(args)
+      @list = args.fetch(:list)
+    end
+
+    # Parses OPML, JSON, or plain text documents and returns an Array of feed urls.
+    #
+    # @return [Array]
+    def parse
+      loaded_list = load_resource(list)
+      case File.extname list
+      when '.xml' || '.opml'
+        Nokogiri::XML(loaded_list).xpath('//@xmlUrl').map(&:value)
+      when '.json'
+        JSON.parse(loaded_list)
+      when '.txt'
+        loaded_list.split("\n")
+      end
+    end
+  end
+end

data/lib/mako/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Mako
+  VERSION = '0.1.0'
+end

data/lib/mako/view_helpers.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module ViewHelpers
+  # Returns today's date in Day, Date Month Year format
+  #
+  # @return [String]
+  def today
+    Time.now.strftime('%A, %d %B %Y')
+  end
+
+  # Returns the current time in month day year hour:minute:second format
+  #
+  # @return [String]
+  def last_updated
+    Time.now.strftime('%d %b %Y %H:%M:%S')
+  end
+
+  # Returns a string with anchor tag links to each Feed generated on the page
+  #
+  # @return [String]
+  def quick_nav(feeds)
+    feeds.select { |feed| feed.articles.size.positive? }
+         .each_with_index.inject('') do |string, (feed, index)|
+      string += "<a href='#feed-#{index}' class='quick-nav-item'>#{feed.title} <div class='circle'>#{feed.articles.size}</div></a>"
+      string
+    end
+  end
+end

data/lib/mako/writer.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Mako
+  class Writer
+    attr_reader :renderer, :destination
+
+    def initialize(args)
+      @renderer = args.fetch(:renderer)
+      @destination = args.fetch(:destination)
+    end
+
+    def write
+      File.open(destination, 'w+', encoding: 'utf-8') do |f|
+        f.write(renderer.render)
+      end
+    end
+  end
+end

data/lib/mako.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'time'
+require 'erb'
+require 'logger'
+require 'faraday'
+require 'feedjira'
+require 'nokogiri'
+require 'json'
+require 'sass'
+
+require_relative 'mako/core_ext'
+require_relative 'mako/errors'
+require_relative 'mako/file_open_util'
+require_relative 'mako/mako_logger'
+require_relative 'mako/view_helpers'
+require_relative 'mako/configuration'
+require_relative 'mako/subscription_list_parser'
+require_relative 'mako/feed'
+require_relative 'mako/article'
+require_relative 'mako/feed_requester'
+require_relative 'mako/feed_constructor'
+require_relative 'mako/html_renderer'
+require_relative 'mako/sass_renderer'
+require_relative 'mako/writer'
+require_relative 'mako/core'
+require_relative 'mako/cli'
+
+module Mako
+  def self.logger
+    @logger ||= MakoLogger.new(STDOUT)
+  end
+
+  def self.config
+    @config ||= Configuration.load(File.expand_path('config.yaml', Dir.pwd))
+  end
+
+  def self.errors
+    @errors ||= Errors.new
+  end
+end

data/lib/templates/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'mako'

data/lib/templates/config.yaml

@@ -0,0 +1,14 @@
+---
+# This configuration file is where you can change settings for your 
+# Mako site.
+
+# To change the theme, uncomment the next line and change the name of the 
+# theme.  Be sure that your .html.erb and .scss files both match the 
+# name of the theme. 
+
+# theme: simple
+
+# By default, images are removed from any articles from your feeds. If you
+# want images to be loaded in, change this next line to false. 
+
+# sanitize_images: true

data/lib/templates/sample_subscriptions/subscriptions.json

@@ -0,0 +1 @@
+["https://jonathanpike.net/feed.xml","https://daringfireball.net/feeds/main","https://marco.org/rss","https://www.speedshop.co/feed.xml","https://tenderlovemaking.com/atom.xml"]

data/lib/templates/sample_subscriptions/subscriptions.txt

@@ -0,0 +1,5 @@
+https://jonathanpike.net/feed.xml
+https://daringfireball.net/feeds/main
+https://marco.org/rss
+https://www.speedshop.co/feed.xml
+https://tenderlovemaking.com/atom.xml

data/lib/templates/sample_subscriptions/subscriptions.xml

@@ -0,0 +1,12 @@
+<opml version="2.0">
+	<body>
+		<outline text="Subscriptions" title="Subscriptions">
+			<outline xmlUrl='https://jonathanpike.net/feed.xml' />
+<outline xmlUrl='https://daringfireball.net/feeds/main' />
+<outline xmlUrl='https://marco.org/rss' />
+<outline xmlUrl='https://www.speedshop.co/feed.xml' />
+<outline xmlUrl='https://tenderlovemaking.com/atom.xml' />
+	
+		</outline>
+	</body>
+</opml>

data/lib/templates/themes/sass/_fonts.scss

@@ -0,0 +1,38 @@
+// Headers
+h1, h2, h3, h4, h5, h6,
+.h1, .h2, .h3, .h4, .h5, .h6 {
+  margin-top: $headings-margin-top;
+  margin-bottom: $headings-margin-bottom;
+  font-family: $headings-font-family;
+  font-weight: $headings-font-weight;
+  line-height: $headings-line-height;
+  color: $headings-color;
+}
+
+h1, .h1 { font-size: $font-size-h1; }
+h2, .h2 { font-size: $font-size-h2; }
+h3, .h3 { font-size: $font-size-h3; }
+h4, .h4 { font-size: $font-size-h4; }
+h5, .h5 { font-size: $font-size-h5; }
+h6, .h6 { font-size: $font-size-h6; }
+
+// Horizontal Rules
+hr {
+  margin-top: 1rem;
+  margin-bottom: 1rem;
+  border: 0;
+  border-top: 1px solid rgba($pd-black,.1);
+}
+
+// Blockquotes
+blockquote {
+  padding: (1rem / 2) 1rem;
+  margin-bottom: 1rem;
+  font-size: $font-size-base * 1.1;
+  color: $pd-light-gray;
+  border-left: .15rem solid $pd-banner;
+}
+
+.bold { 
+  font-weight: bold;
+}

data/lib/templates/themes/sass/_layout.scss

@@ -0,0 +1,97 @@
+body {
+  font-family: $pd-font-family-sans-serif;
+  font-size: $font-size-base;
+  background-color: $pd-off-white;
+  margin: 0;
+}
+
+a:link {
+  border-bottom: 1px black dotted;
+  text-decoration: none;
+  color: $pd-black;
+  transition: all 0.2s ease;
+  -webkit-transition: all 0.2s ease;
+}
+
+a:visited {
+  text-decoration: none;
+  color: $pd-black;
+}
+
+a:hover{
+  text-decoration: none;
+  color: $pd-dark-blue;
+}
+
+.meta {
+  color: $pd-light-gray;
+}
+
+#banner { 
+  background-color: $pd-banner; 
+  text-align: center;
+  color: $pd-white;
+  h4 {
+    font-style: italic;
+  }
+}
+
+.banner-text {
+  display: inline-block;
+}
+
+#quick-nav {
+  background-color: $pd-banner-light;
+  max-width: 650px;
+  margin: auto;
+  margin-top:5px;
+  padding: 5px;
+  text-align: center;
+  @media only screen and (max-width: $screen-phone) {
+    margin-top: 0px;
+  }
+}
+
+.quick-nav-item {
+  display: inline-block;
+  padding: 3px;
+  margin: 0 0.25em;
+}
+
+a.quick-nav-item {
+  border-bottom: 0px;
+  color: $pd-white;
+}
+
+a.quick-nav-item:hover { 
+  color: $pd-banner-dark;
+}
+
+.circle { 
+  display: inline-block;
+  background: #84BE62;
+  padding: 3px 9px;
+  border: 2px solid $pd-white;
+  border-radius: 100px;
+}
+
+.back-to-top {
+  text-align: right;
+}
+
+#feed-container {
+  max-width: 700px;
+  margin: auto;
+  padding: 1em;
+}
+
+.article-header {
+  margin-left: -1em;
+}
+
+#footer {
+   border-top: 1px dotted $pd-light-gray;
+   text-align: center;
+   padding-top: 3em;
+   margin-bottom: 3em;
+}