canvas-workflow 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4776993ecddc6700c7ada9b4219877137866df237762eafc2d1c32d0e1320cd2
+  data.tar.gz: 59a259dfbba4cd751c62b3df9c8422e17dab2a2af8f76ad130f78bf0548474b4
+SHA512:
+  metadata.gz: 80fa795db4d8087402688e6ecefb6b38faa04e278d8ed0180674f40d81142d9256c44e2715814128f3bbd4fb271eb7026d98ce49302dd78ddb9f5c5442b3dcc6
+  data.tar.gz: 90bc64fdb497861414f74318832e31dc114e508f1d43fa9cb65d9b37540924c57218f77badbe368af9585881fb80166c29730bf38ccc6b3e15e256822ba7fcd1

data/CHANGELOG.md

@@ -0,0 +1,27 @@
+## [0.5.0](https://github.com/jiverson002/canvas-workflow/releases/tag/0.5.0)
+* Renamed project to canvas-workflow.
+* Incorporated canvas-workflow-travis into this project.
+
+## [0.4.0](https://github.com/jiverson002/canvas-workflow/releases/tag/0.4.0)
+* Pre-release.
+
+### Enhancements
+* Moved 'development' dependencies to Gemfile and listed bundler as only
+  development dependency in gemspec.
+* Made gist iframe width 100%.
+* Refactored monkey-patch of resolve\_path\_courses in
+  Canvas::Workflow::Jekyll::FileTag out of FileTag class into pandarus.rb.
+* Upgraded to canvas-workflow-travis v0.12.0.
+* Added the assignment tag, which is used internally to dynamically lookup   
+  assignment ids.
+
+## [0.3.0](https://github.com/jiverson002/canvas-workflow/releases/tag/0.3.0)
+* Pre-release.
+* Renamed project to canvas-workflow-jekyll.
+* Incorporated the former standalone gem jekyll-canvas-tags into this project.
+
+## 0.2.0
+* Pre-release.
+
+## [0.1.0](https://github.com/jiverson002/canvas-workflow/releases/tag/0.1.0)
+* Pre-release.

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Jeremy Iverson
+
+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,69 @@
+---
+---
+
+# Canvas Workflow
+
+Welcome to your new Canvas Workflow! In this directory, you'll find the files
+you need to be able to package up your theme into a gem. Put your layouts in `_layouts`, your includes in `_includes`, your sass files in `_sass` and any
+other assets in `assets`.  
+
+To experiment with this code, add some sample content and run `bundle exec
+jekyll serve` – this directory is setup just like a Jekyll site!
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your Jekyll site's `Gemfile`:
+
+```ruby
+gem "canvas-workflow-jekyll", "=0.1.0"
+```
+
+And add this line to your Jekyll site's `_config.yml`:
+
+```yaml
+theme: canvas-workflow-jekyll
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install canvas-workflow-jekyll
+
+## Usage
+
+TODO: Write usage instructions here. Describe your available layouts, includes,
+sass and/or assets.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+[https://github.com/jiverson002/canvas-workflow-jekyll](https://github.com/jiverson002/canvas-workflow-jekyll).
+This project is intended to be a safe, welcoming space for collaboration, and
+contributors are expected to adhere to the [Contributor
+Covenant](http://contributor-covenant.org) code of conduct.
+
+## Development
+
+To set up your environment to develop this theme, run `bundle install`.
+
+Your theme is setup just like a normal Jekyll site! To test your theme, run
+`bundle exec jekyll serve` and open your browser at `http://localhost:4000`.
+This starts a Jekyll server using your theme. Add pages, documents, data, etc.
+like normal to test your theme's contents. As you make modifications to your
+theme and to your content, your site will regenerate and you should see the
+changes in the browser after a refresh, just like normal.
+
+When your theme is released, only the files in `_layouts`, `_includes`, `_sass`
+and `assets` tracked with Git will be bundled. To add a custom directory to your
+theme-gem, please edit the regexp in `canvas-workflow-jekyll.gemspec`
+accordingly.
+
+## License
+
+The theme is available as open source under the terms of the [MIT
+License](https://opensource.org/licenses/MIT).

data/_includes/newline

@@ -0,0 +1,4 @@
+{%- capture newLine %}
+{% endcapture -%}
+{%- capture blockNewLine %}
+    {% endcapture -%}

data/_layouts/assignment.html

@@ -0,0 +1,20 @@
+{%- include newline -%}
+
+assignment:
+  # id
+  id: {% assignment %}
+
+  # assignment[name]
+  name: |
+    {{ page.title }}
+
+  # assignment[description]
+  description: |-
+    {{ content | replace: newLine, blockNewLine }}
+
+  # assignment[due_at]
+  due_at: |
+    {{ page.due_at }}
+
+  # assignment[notify_of_update]
+  notify_of_update: {{ page.notify_of_update }}

data/_layouts/page.html

@@ -0,0 +1,23 @@
+{%- include newline -%}
+
+wiki_page:
+  # wiki_page[title]
+  title: |
+    {{ page.title }}
+
+  # wiki_page[body]
+  body: |-
+    {{ content | replace: newLine, blockNewLine }}
+
+  # wiki_page[editing_roles]
+  editing_roles: {{ page.editing_roles }}
+
+  # wiki_page[notify_of_update]
+  notify_of_update: {{ page.notify_of_update }}
+
+  # wiki_page[published]
+  published: {{ page.published }}
+
+  # wiki_page[front_page]
+  front_page: {{ page.front_page }}
+

data/_layouts/syllabus.html

@@ -0,0 +1,6 @@
+{%- include newline -%}
+
+course:
+  # course[syllabus_body]
+  syllabus_body: |-
+    {{ content | replace: newLine, blockNewLine }}

data/assets/_config.yml

@@ -0,0 +1,41 @@
+################################################################################
+################################################################################
+
+# Use the canvas-workflow theme to produce correctly formatted yaml files for
+# use with the canvas-workflow cli.
+theme: canvas-workflow
+
+# Disable any plugins that are not explicitly enabled (whitelisted) below.
+safe: true
+# Allow the set of plugins included with the canvas-workflow gem to provide
+# useful tags for the Canvas LMS.
+whitelist:
+  - canvas-workflow
+plugins:
+  - canvas-workflow
+
+# Render pages, even those marked unpublished --- this allows a page to be
+# rendered and uploaded, but marked as not published on Canvas, if
+# [published: false] appears in the yaml front matter.
+unpublished: true
+
+# Disable syntax highlighting.
+highlighter: none
+
+# Fail build if there is incorrect yaml front matter.
+strict_front_matter: true
+
+# Set the default layouts for certain types of files.
+defaults:
+  - scope:
+      path: "README.md"
+    values:
+      layout: syllabus
+  - scope:
+      path: "assignments"
+    values:
+      layout: assignment
+  - scope:
+      path: "pages"
+    values:
+      layout: page

data/bin/canvas

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'canvas-workflow'
+
+Canvas::Workflow::CLI.start(ARGV)

data/lib/canvas-workflow.rb

@@ -0,0 +1,6 @@
+require 'canvas/workflow'
+
+module Canvas
+  module Workflow
+  end
+end

data/lib/canvas/workflow.rb

@@ -0,0 +1,78 @@
+require 'time'      # needed to fix dtao/safe_yaml#80
+require 'safe_yaml' # yaml parser
+
+require 'canvas/workflow/cli'
+require 'canvas/workflow/client'
+require 'canvas/workflow/pandarus'
+require 'canvas/workflow/tags'
+require 'canvas/workflow/travis'
+require 'canvas/workflow/version'
+
+SafeYAML::OPTIONS[:default_mode] = :safe
+
+module Canvas
+  module Workflow
+    # Access the configuration object for this Canvas Workflow site.
+    #
+    # @return the configuration object for this Canvas Workflow site
+    def self.config
+      # load user configuration
+      @config ||= YAML.load_file('_config.yml')['canvas']
+    end
+
+    # Access the Canvas client for this Canvas Workflow site.
+    #
+    # @return [Canvas::Client] the Canvas client for this Canvas Workflow site
+    def self.client
+      @client ||= Client.new(config)
+    end
+
+    # Is +file+ excluded from upload?
+    #
+    # @param file [String] a file name
+    # @return [Boolean] true if the file has been excluded from upload.
+    def self.excluded?(file)
+      return false if config['exclude'].nil?
+
+      # get the list of files that has been explicitly excluded
+      @excluded ||= Dir.glob(config['exclude'].map do |f|
+        if File.directory?(f)
+          if f.end_with?("/")
+            f + "**/*"
+          else
+            f + "/**/*"
+          end
+        else
+          f
+        end
+      end)
+
+      # check if the param file has been excluded
+      @excluded.include?(file)
+    end
+
+    # Is +file+ included for upload?
+    #
+    # @param file [String] a file name
+    # @return [Boolean] true if the file has been included for upload.
+    def self.included?(file)
+      return false if config['include'].nil?
+
+      # get the list of files that has been explicitly included
+      @included ||= Dir.glob(config['include'].map do |f|
+        if File.directory?(f)
+          if f.end_with?("/")
+            f + "**/*"
+          else
+            f + "/**/*"
+          end
+        else
+          f
+        end
+      end)
+
+      # check if the param file has been included
+      @included.include?(file)
+    end
+  end
+end

data/lib/canvas/workflow/cli.rb

@@ -0,0 +1,24 @@
+require 'thor'
+
+module Canvas
+  module Workflow
+    module CLI
+      class Main < Thor
+      end
+
+      def self.desc(*args)
+        Main.send(:desc, *args)
+      end
+
+      def self.subcommand(*args)
+        Main.send(:subcommand, *args)
+      end
+
+      def self.start(*args)
+        Main.send(:start, *args)
+      end
+    end
+  end
+end
+
+Dir[File.dirname(__FILE__) + '/cli/*.rb'].each { |file| require file }

data/lib/canvas/workflow/cli/deploy.rb

@@ -0,0 +1,79 @@
+require 'time'      # needed to fix dtao/safe_yaml#80
+require 'safe_yaml' # yaml parser
+
+SafeYAML::OPTIONS[:default_mode] = :safe
+
+module Canvas
+  module Workflow
+    module CLI
+      class Deploy < Thor
+        desc "deploy", "Deploy the Canvas Workflow project to a Canvas LMS"
+        def deploy
+          # upload syllabus
+          # FIXME this only compacts one level
+          Dir.glob('README.md').select do |md_file|
+            upload?(md_file)
+          end.each do |md_file|
+            html_file = File.join('_site', File.basename(md_file, '.md') + '.html')
+
+            puts "=> uploading #{html_file}"
+
+            content = YAML.load_file(html_file)
+
+            content.each { |k,v| v.compact! }.compact!
+
+            Workflow.client.update_course(course, content)
+          end
+
+          # upload pages
+          # FIXME see upload syllabus
+          Dir.glob('pages/*.md').select do |md_file|
+            upload?(md_file)
+          end.each do |md_file|
+            url       = File.basename(md_file, '.md')
+            html_file = File.join('_site', 'pages', url + '.html')
+
+            puts "=> uploading #{html_file}"
+
+            content = YAML.load_file(html_file)
+
+            content.each { |k,v| v.compact! }.compact!
+
+            Workflow.client.update_create_page_courses(course, url, content)
+          end
+
+          # upload assignments
+          # FIXME see upload syllabus
+          Dir.glob('assignments/*.md').select do |md_file|
+            upload?(md_file)
+          end.each do |md_file|
+            html_file = File.join('_site', 'assignments', File.basename(md_file, '.md') + '.html')
+
+            puts "=> uploading #{html_file}"
+
+            content = YAML.load_file(html_file)
+
+            content.each { |k,v| v.compact! }.compact!
+
+            Workflow.client.edit_assignment(course, content['assignment']['id'], content)
+          end
+        end
+
+        default_task :deploy
+
+        private
+
+        def course
+          @course ||= Workflow.config['course']
+        end
+
+        def upload?(file)
+          Travis.created?(file) || Travis.modified?(file)
+        end
+      end
+
+      desc "deploy", "Deploy a Canvas Workflow project to a Canvas LMS"
+      subcommand "deploy", Deploy
+    end
+  end
+end

data/lib/canvas/workflow/cli/jekyll.rb

@@ -0,0 +1,28 @@
+module Canvas
+  module Workflow
+    module CLI
+      class Jekyll < Thor
+        desc "build", "Build the Canvas Workflow project"
+        option :with_bundler, :aliases => :b,
+          :type => :boolean, :default => false,
+          :desc => "build using bundler?"
+        def build
+          assets = File.expand_path("../../../../../assets", __FILE__)
+          asset  = File.join(assets, "_config.yml")
+
+          cmd = ""
+          cmd << "bundle exec " if options[:with_bundler]
+          cmd << "jekyll build --config #{asset},_config.yml --verbose"
+          #puts "#{cmd}"
+          exec("#{cmd}")
+        end
+      end
+
+      desc "jekyll SUBCOMMAND ...ARGS", "Manage static site generator"
+      subcommand "jekyll", Jekyll
+    end
+  end
+end
+
+# Canvas::Workflow::CLI.desc "jekyll SUBCOMMAND ...ARGS", "Manage static site generator"
+# Canvas::Workflow::CLI.subcommand "jekyll", Canvas::Workflow::CLI::Jekyll