mako_rss 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bb8b5a3c394b989b9722f6ae04b6373d23ba7e08
+  data.tar.gz: 11efdfb201da11cf3ec348d84ae41c639c7a52a8
+SHA512:
+  metadata.gz: a7603d695ded87c83719c2cd159d4e33f85878525fdd29c597c6a6fd033148c7e7a3add809f824c6e544634b196b109b3a1ada4d8cb0fcb5b6a44f7c93751f99
+  data.tar.gz: 0ba4e36181aa8dd232ad7f83fb3960dba146c136095cd0e875e0547a262aee1ceb80980e2a98a886a1534bb000bfd5259df3e77815ea87c0da2f8ea1bec675d9

data/.gitignore

@@ -0,0 +1,33 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+.byebug_history
+.sass-cache
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+# .ruby-version
+# .ruby-gemset

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,7 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  TargetRubyVersion: 2.3
+
+Layout/IndentHeredoc:
+  EnforcedStyle: squiggly

data/.rubocop_todo.yml

@@ -0,0 +1,38 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2017-06-06 16:33:49 -0400 using RuboCop version 0.35.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 3
+Metrics/AbcSize:
+  Max: 26
+
+# Offense count: 37
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 629
+
+# Offense count: 5
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 25
+
+# Offense count: 1
+Style/AccessorMethodName:
+  Exclude:
+    - 'lib/mako/core.rb'
+
+# Offense count: 22
+# Configuration parameters: Exclude.
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowAsExpressionSeparator.
+Style/Semicolon:
+  Exclude:
+    - 'lib/mako/article.rb'

data/.travis.yml

@@ -0,0 +1,7 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+cache: bundler
+before_install: gem install bundler -v 1.14.6
+

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mako.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Jonathan Pike
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,124 @@
+# Mako 🥛 [![Build Status](https://travis-ci.org/jonathanpike/mako.svg?branch=master)](https://travis-ci.org/jonathanpike/mako) [![Coverage Status](https://coveralls.io/repos/github/jonathanpike/mako/badge.svg?branch=master)](https://coveralls.io/github/jonathanpike/mako?branch=master)
+
+Mako is a static-site generating RSS reader.  Mako is also my son's name for
+milk.
+
+I designed Mako with the following principals in mind: 
+
+1. RSS feeds are freely available, so reader software should be freely
+   available.
+2. RSS feeds are part of the web, so reader software should be part of the web.
+
+## Installation
+
+To install Mako, do:
+
+    $ gem install mako
+
+Once the gem is installed, you'll need to generate a new Mako site.  You can do
+this in 1 of 2 ways.  
+
+1. If you already have a directory that you want Mako to live in, run: 
+
+    $ mako new
+
+2. If you don't have a directory and want Mako to create on, run: 
+
+    $ mako new path/to/directory
+
+In your new Mako site, you'll see a directory structure like this: 
+
+```
+.
+├── sample_subscriptions
+|   ├── subscriptions.json
+|   ├── subscriptions.txt
+|   └── subscriptions.xml
+├── site
+├── themes
+|   ├── sass
+|   |  ├── _fonts.scss
+|   |  ├── _layout.scss
+|   |  ├── _reboot.scss
+|   |  ├── _utitilies.scss
+|   |  └── _variables.scss
+|   ├── simple.html.erb
+|   └── simple.scss
+├── Gemfile
+└── config.yaml
+```
+
+## Adding Feeds
+
+Once Mako is installed and your Mako site has been created, the next step is to
+add your own feeds.  Mako currently supports 3 formats: 
+
+1. OPML
+2. JSON 
+3. Plain Text
+
+In the [`sample_subscriptions`](/lib/templates/sample_subscriptions) directory, you'll see an example of each format.
+Whichever you choose, place the file in the root directory and be sure its name
+is `subscriptions`.  The file extension (`.xml`/`.opml`, `.json`, or `.txt`)
+will tell Mako what kind of subscription file you have.
+
+## Configuration
+
+Mako has very few configuration options.  You can see all of them in the
+comments in [`config.yaml`](/lib/templates/config.yaml). 
+
+## Building your Site
+
+Once you've added your subscriptions, you can build your Mako site for the first
+time.  By default, Mako only builds the HTML portion of the site with the `mako
+build` command.  Since the CSS has not been generated, use the `--with-sass`
+flag, like this: 
+
+    $ mako build --with-sass
+
+The built files will be present in the `site` directory after the `build`
+command has been run. 
+
+At present, Mako only displays the last 2 days worth of content from your feeds.
+If a feed has not been updated in the last 2 days, it will not be displayed on
+your Mako site. Similarly, articles that were published > 2 days in the past
+will not be displayed on your Mako site. 
+
+## Themes 
+
+Mako comes with a simple theme of my own design (and own liking).  Perhaps you
+want something different.  Mako's themes are templated with
+[ERB](https://ruby-doc.org/stdlib-2.4.1/libdoc/erb/rdoc/ERB.html).  You have
+access to the following convenience methods: 
+  - `today` - Gives you the current date in Day, `Date Month Year` format.
+  - `last_updated` - Gives you the current date and time in `day month year
+  hour:minute:second` format.
+
+Within your template, you can access the feed data through the `feeds` array.
+The `feeds` array contains `feed` objects, which have the following attributes: 
+  - `title` - a string of the feed title.
+  - `url` - a string of the feed url.
+  - `articles` - an array of the articles associated with the feed.
+
+To access the `articles` within a `feed`, you can use:
+  - `articles_desc` - sorts the array of articles by newest first.
+  - `articles_asc` - sorts the array of articles by oldest first.
+
+`articles` contain the following attributes: 
+  - `title` - a string of the article title.
+  - `url` - a string of the article url.
+  - `published` - a `Time` instance of the published date. Can also be accessed
+    by `formatted_published` to get it as formatted string.
+  - `summary` - a string of the article content.
+
+When in doubt, check out the implementation of [my
+theme](/lib/templates/themese/simple.html.erb).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jonathanpike/mako.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rubocop/rake_task'
+
+Rake::TestTask.new do |t|
+  t.pattern = 'test/*_test.rb'
+end
+
+RuboCop::RakeTask.new(:rubocop)
+
+task default: %i[test rubocop]

data/bin/mako

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../lib/mako'
+
+Mako::CLI.start(ARGV)

data/lib/mako/article.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Mako
+  class Article
+    attr_reader :title, :published, :summary, :url
+
+    def initialize(args)
+      @title = args.fetch(:title, '')
+      @published = args.fetch(:published)
+      @summary = sanitize(args.fetch(:summary))
+      @url = args.fetch(:url)
+    end
+
+    # Converts published Time object to formatted string
+    #
+    # @return [String]
+    def formatted_published
+      @published.strftime('%A, %d %B %Y at %I:%M %P')
+    end
+
+    private
+
+    # @private
+    # Removes img tags (if configured) and transforms h1 tags into
+    # p tags with the class bold
+    #
+    # @param [String] html an html document string
+    # @return [String] a sanitized html document string
+    def sanitize(html)
+      doc = Nokogiri::HTML::DocumentFragment.parse(html)
+      doc.css('img').each(&:remove) if Mako.config.sanitize_images
+      doc.css('h1,h2,h3,h4,h5,h6').each { |n| n.name = 'p'; n.set_attribute('class', 'bold') }
+      doc.to_s
+    end
+  end
+end

data/lib/mako/cli.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require_relative 'commands/build'
+require_relative 'commands/new'
+require_relative 'commands/version'
+
+module Mako
+  class CLI
+    COMMANDS = %w[build new version].freeze
+
+    # Takes ARGV and parses the first element (command) to see if it is
+    # in the commands array.  If not, display help.
+    #
+    # @param [Array] argv
+    def self.start(argv)
+      command = argv.shift
+      if COMMANDS.include? command
+        CLI.invoke(command, argv)
+      else
+        help = <<~EOS
+          Usage:
+            mako [subcommand] [path...]
+
+          Subcommands:
+            new       Create a new Mako scaffold in PATH.  If no PATH provided, defaults to current directory.
+            build     Build your Mako site. Default: only build HTML.
+            version   Display the version.
+
+          Options:
+            --with-sass  When supplied to build, also generates CSS from SCSS files.
+        EOS
+        Mako.logger.info help
+      end
+    end
+
+    # Calls #perform on the provided command class. When the command is done
+    # running, print out any errors that the command had.
+    #
+    # @param [String] command
+    # @param [Array] args the remainder of the ARGV arguments
+    def self.invoke(command, args = [])
+      Object.const_get("Mako::#{command.capitalize}").perform(args)
+      return unless Mako.errors.any?
+      Mako.errors.messages.each do |error_msg|
+        Mako.logger.warn error_msg
+      end
+    end
+  end
+end

data/lib/mako/commands/build.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Mako
+  class Build
+    # Calls #build on Mako::Core.  This class stores knowledge of all of the
+    # different component classes needed to build the site.
+    #
+    # @param [Array] args the following are accepted arguments:
+    #                "--with-sass": builds with SassRenderer
+    def self.perform(args)
+      subscription_list = load_subscription_list
+      if args.include? '--with-sass'
+        Mako::Core.new(requester: FeedRequester,
+                       constructor: FeedConstructor,
+                       renderers: [HTMLRenderer,
+                                   SassRenderer],
+                       writer: Writer,
+                       subscription_list: subscription_list).build
+      else
+        Mako::Core.new(requester: FeedRequester,
+                       constructor: FeedConstructor,
+                       renderers: [HTMLRenderer],
+                       writer: Writer,
+                       subscription_list: subscription_list).build
+      end
+    end
+
+    def self.load_subscription_list
+      path = File.expand_path(Dir.glob('subscriptions.*').first, Dir.pwd)
+      Mako::SubscriptionListParser.new(list: path).parse
+    end
+  end
+end

data/lib/mako/commands/new.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+
+module Mako
+  class New
+    # Copies template files stored in ../lib/templates to specified directory.
+    # If the directory specified doesn't exist, it will be created.
+    # If no directory is specified, it defaults to the current directory.
+    def self.perform(args)
+      location = args.empty? ? Dir.pwd : File.expand_path(args.join(' '), Dir.pwd)
+      create_dir(File.basename(location)) if location != Dir.pwd && File.directory?(location)
+      copy_templates(location)
+      Mako.logger.info "Created new Mako installation in #{location}"
+    end
+
+    # @private
+    # Copies source templates to specified path.
+    def self.copy_templates(path)
+      FileUtils.cp_r "#{Mako.config.source_templates}/.", path
+    end
+
+    # If the directory does not exist, create the specified directory.
+    def self.create_dir(path)
+      FileUtils.mkdir path
+    end
+  end
+end

data/lib/mako/commands/schedule.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'whenever'
+
+module Mako
+  class Schedule
+    def self.perform(_args)
+      Whenever::CommandLine.execute(file: File.expand_path('schedule.rb', Dir.pwd),
+                                    write: true)
+    end
+  end
+end

data/lib/mako/commands/version.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative '../version'
+
+module Mako
+  class Version
+    def self.perform(_args)
+      puts "mako #{VERSION}"
+    end
+  end
+end

data/lib/mako/configuration.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module Mako
+  class Configuration
+    DEFAULT_CONFIGURATION = { 'source_templates' => File.expand_path('../templates', File.dirname(__FILE__)),
+                              'destination' => File.expand_path('site/', Dir.pwd),
+                              'theme' => 'simple',
+                              'sanitize_images' => true,
+                              'config_file' => '' }.freeze
+
+    include FileOpenUtil
+
+    # Loads default config file and attempts to merge in any user settings.
+    # Creates a new instance of Mako::Configuration.
+    #
+    # @param [String]
+    # @return [Mako::Configuration]
+    def self.load(file)
+      begin
+        user_config_yaml = load_resource(file)
+      rescue SystemCallError
+        config = DEFAULT_CONFIGURATION
+        return new(config)
+      end
+      user_config = YAML.safe_load(user_config_yaml) || {}
+      user_config['config_file'] = file
+      config = DEFAULT_CONFIGURATION.merge(user_config)
+      new(config)
+    end
+
+    attr_reader :source_templates, :theme, :destination, :sanitize_images,
+                :config_file
+
+    def initialize(args)
+      @source_templates = args.fetch('source_templates')
+      @theme = args.fetch('theme')
+      @destination = args.fetch('destination')
+      @sanitize_images = args.fetch('sanitize_images')
+      @config_file = args.fetch('config_file')
+    end
+  end
+end

data/lib/mako/core.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Mako
+  class Core
+    include ERB::Util
+    include ViewHelpers
+
+    attr_reader :feeds, :requester, :constructor, :renderers, :writer,
+                :subscription_list
+
+    def initialize(args)
+      @feeds = []
+      @requester = args.fetch(:requester)
+      @constructor = args.fetch(:constructor)
+      @renderers = args.fetch(:renderers)
+      @writer = args.fetch(:writer)
+      @subscription_list = args.fetch(:subscription_list)
+    end
+
+    # Gets list of feed_urls, requests each of them and uses the constructor to
+    # make Feed and Article objects, then calls to the renderers to render
+    # the page and stylesheets.
+    def build
+      log_configuration_information
+
+      if subscription_list.empty?
+        Mako.logger.warn 'No feeds were found in your subscriptions file. Please add feeds and try again.'
+        return
+      end
+
+      log_time do
+        request_and_build_feeds
+        renderers.each do |renderer|
+          renderer_instance = renderer.new(bound: self)
+          writer.new(renderer: renderer_instance,
+                     destination: File.expand_path(renderer_instance.file_path, Mako.config.destination)).write
+        end
+      end
+    end
+
+    # Returns the Binding of Core for the ERB renderer. Binding encapsulates the
+    # execution context for the Core class, and makes all of the variables
+    # and methods of Core available to the renderer.
+    #
+    # @return [Binding]
+    def get_binding
+      binding
+    end
+
+    private
+
+    # @private
+    # Prints configuration file, source, and destination directory to STDOUT.
+    def log_configuration_information
+      Mako.logger.info "Configuration File: #{Mako.config.config_file}"
+      Mako.logger.info "Theme: #{Mako.config.theme}"
+      Mako.logger.info "Destination: #{Mako.config.destination}"
+    end
+
+    # Provides build time logging information and writes it to STDOUT.
+    def log_time
+      Mako.logger.info 'Generating...'
+      start_time = Time.now.to_f
+      yield
+      generation_time = Time.now.to_f - start_time
+      Mako.logger.info "done in #{generation_time} seconds"
+    end
+
+    def request_and_build_feeds
+      requesters = subscription_list.map { |feed_url| requester.new(feed_url: feed_url) }
+      requesters.each do |feed_request|
+        feed_response = feed_request.fetch
+        next unless feed_request.ok?
+        constructed_feed = constructor.new(feed_data: feed_response.body,
+                                           feed_url: feed_response.feed_url)
+                                      .parse_and_create
+        feeds << constructed_feed if constructed_feed
+      end
+    end
+  end
+end

data/lib/mako/core_ext/numeric.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+class Numeric
+  SECONDS_IN_DAY = 86_400
+
+  def days
+    self * SECONDS_IN_DAY
+  end
+  alias day days
+end

data/lib/mako/core_ext/time.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'time'
+
+class Time
+  def beginning_of_day
+    Time.new(year, month, day,
+             0, 0, 0, utc_offset)
+  end
+end

data/lib/mako/core_ext.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative 'core_ext/numeric'
+require_relative 'core_ext/time'

data/lib/mako/errors.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Mako
+  class Errors
+    attr_accessor :messages
+
+    def initialize
+      @messages = []
+    end
+
+    # Add an error message to the messages array
+    #
+    # @param [String]
+    def add_error(msg)
+      messages << msg
+    end
+
+    # Predicate method to see if there are any error messages
+    #
+    # @return [Boolean]
+    def any?
+      messages.count.positive?
+    end
+  end
+end

data/lib/mako/feed.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Mako
+  class Feed
+    attr_accessor :feed_url, :url, :title, :articles
+
+    def initialize(args)
+      @url = args.fetch(:url)
+      @title = args.fetch(:title)
+      @articles = []
+    end
+
+    # Returns the articles array sorted by date published ascending
+    # (oldest first).
+    #
+    # @return [Array]
+    def articles_asc
+      articles.sort_by(&:published)
+    end
+
+    # Returns the articles array sorted by date published descending
+    # (newest first).
+    #
+    # @return [Array]
+    def articles_desc
+      articles_asc.reverse
+    end
+  end
+end