coursemology-polyglot 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: adb65659222b8379e474afaf85155592557f66fc
-  data.tar.gz: bc9932cd23bdb2e9fa8c361abe45d2123f243101
+  metadata.gz: 5362954fc3f5ce4201052cca9dc8f60423d801e2
+  data.tar.gz: 28c1d21015e9025394f35eded6cdba6ea66bf43a
 SHA512:
-  metadata.gz: b3fe16093ab865f4b64f6e7dadc8c5682e2c538db4f33e24526444844ef223b725637d67b367b16971565fdf57864c7a6a1faebc1986c58880e0fb176db74c9f
-  data.tar.gz: afa94849bd67f275640ba7cdd47bb190a9e85275933306dea4108e88a860eed53484ff4127eb5a003a7cec45b174cc3685daa22351ec9e3b9aff18798132c7a4
+  metadata.gz: 0c34a0c52348298a4ad937ab75ab2316cea1a337ad038b8a69dd2f616da1c18022cbe798d4490d7e07a00d8c0f6b8367b2a43b93f7d3bcdfc7a26aa3479001fc
+  data.tar.gz: 03e2719ad1119acff8c6b2bbd8f5acb8f372d92b8d1558942cf122cdb0ec9a03094e370c433eb6878630f7b3c2dd02f58ef8564ad602e7c4d36aee45ac730194

data/.idea/Coursemology Polyglot.iml

@@ -1,9 +1,20 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <module type="RUBY_MODULE" version="4">
+  <component name="FacetManager">
+    <facet type="gem" name="Gem">
+      <configuration>
+        <option name="GEM_APP_ROOT_PATH" value="" />
+        <option name="GEM_APP_TEST_PATH" value="" />
+        <option name="GEM_APP_LIB_PATH" value="" />
+      </configuration>
+    </facet>
+  </component>
   <component name="NewModuleRootManager" inherit-compiler-output="true">
     <exclude-output />
     <content url="file://$MODULE_DIR$" />
     <orderEntry type="inheritedJdk" />
     <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="library" scope="PROVIDED" name="json (v1.8.3, ruby-2.3.0-p7) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rake (v10.5.0, ruby-2.3.0-p7) [gem]" level="application" />
   </component>
 </module>

data/.rubocop.unhound.yml

@@ -1,44 +1,4 @@
-AccessorMethodName:
-  Enabled: true
-
-ActionFilter:
-  Enabled: true
-
-Alias:
-  Enabled: true
-
-ArrayJoin:
-  Enabled: true
-
-AsciiComments:
-  Enabled: true
-
-AsciiIdentifiers:
-  Enabled: true
-
-Attr:
-  Enabled: true
-
-BlockNesting:
-  Enabled: true
-
-CaseEquality:
-  Enabled: true
-
-CharacterLiteral:
-  Enabled: true
-
-ClassAndModuleChildren:
-  Enabled: true
-  EnforcedStyle: compact
-
-ClassLength:
-  Enabled: true
-
-ClassVars:
-  Enabled: true
-
-CollectionMethods:
+Style/CollectionMethods:
   Enabled: true
   PreferredMethods:
     reduce:
@@ -46,199 +6,104 @@ CollectionMethods:
     find:
     detect: 'find'
 
-ColonMethodCall:
-  Enabled: true
-
-CommentAnnotation:
-  Enabled: true
-
-CyclomaticComplexity:
-  Enabled: true
-
-Delegate:
-  Enabled: true
-
-DeprecatedHashMethods:
-  Enabled: true
-
-DoubleNegation:
+Style/FileName:
   Enabled: true
 
-EachWithObject:
+Style/GuardClause:
   Enabled: true
 
-EmptyLiteral:
+Style/IfUnlessModifier:
   Enabled: true
 
-Encoding:
-  Enabled: false
-
-EvenOdd:
+Style/PercentLiteralDelimiters:
   Enabled: true
 
-ExtraSpacing:
-  Enabled: false
-
-FileName:
+Style/SignalException:
   Enabled: true
 
-FlipFlop:
+Style/SingleLineBlockParams:
   Enabled: true
 
-FormatString:
+Style/SingleLineMethods:
   Enabled: true
 
-GlobalVars:
+Style/TrailingCommaInArguments:
   Enabled: true
 
-GuardClause:
+Style/TrailingCommaInLiteral:
   Enabled: true
 
-IfUnlessModifier:
+Metrics/AbcSize:
   Enabled: true
 
-IfWithSemicolon:
+Metrics/ClassLength:
   Enabled: true
 
-InlineComment:
-  Enabled: false
-
-Lambda:
+Metrics/ModuleLength:
   Enabled: true
 
-LambdaCall:
+Metrics/CyclomaticComplexity:
   Enabled: true
 
-LineEndConcatenation:
+Metrics/MethodLength:
   Enabled: true
 
-MethodLength:
+Metrics/ParameterLists:
   Enabled: true
 
-ModuleFunction:
+Metrics/PerceivedComplexity:
   Enabled: true
 
-NegatedIf:
+Lint/AssignmentInCondition:
   Enabled: true
 
-NegatedWhile:
+Style/AccessorMethodName:
   Enabled: true
 
-Next:
-  Enabled: true
-
-NilComparison:
-  Enabled: true
-
-Not:
-  Enabled: true
-
-NumericLiterals:
-  Enabled: true
-
-OneLineConditional:
-  Enabled: true
-
-OpMethod:
-  Enabled: true
-
-ParameterLists:
-  Enabled: true
-
-PercentLiteralDelimiters:
-  Enabled: true
-
-PerlBackrefs:
-  Enabled: true
-
-PredicateName:
-  NamePrefixBlacklist: []
-
-Proc:
-  Enabled: true
-
-RaiseArgs:
-  Enabled: true
-
-RegexpLiteral:
-  Enabled: true
-
-SelfAssignment:
-  Enabled: true
-
-SingleLineBlockParams:
-  Enabled: true
-
-SingleLineMethods:
-  Enabled: true
-
-SignalException:
-  Enabled: true
-
-SpecialGlobalVars:
-  Enabled: true
-
-VariableInterpolation:
-  Enabled: true
-
-TrailingComma:
-  Enabled: true
-
-TrivialAccessors:
-  Enabled: true
-
-VariableInterpolation:
-  Enabled: true
-
-WhenThen:
-  Enabled: true
-
-WhileUntilModifier:
-  Enabled: true
-
-# Lint
-
-AmbiguousOperator:
+Style/Alias:
   Enabled: true
+  EnforcedStyle: prefer_alias_method
 
-AmbiguousRegexpLiteral:
+Style/Documentation:
   Enabled: true
 
-AssignmentInCondition:
+Style/DoubleNegation:
   Enabled: true
 
-ConditionPosition:
+Style/EachWithObject:
   Enabled: true
 
-DeprecatedClassMethods:
+Style/EmptyLiteral:
   Enabled: true
 
-ElseLayout:
+Style/ModuleFunction:
   Enabled: true
 
-HandleExceptions:
+Style/OneLineConditional:
   Enabled: true
 
-InvalidCharacterLiteral:
+Style/PerlBackrefs:
   Enabled: true
 
-LiteralInCondition:
+Style/SpecialGlobalVars:
   Enabled: true
 
-LiteralInInterpolation:
+Style/VariableInterpolation:
   Enabled: true
 
-Loop:
+Style/WhenThen:
   Enabled: true
 
-ParenthesesAsGroupedExpression:
+Lint/EachWithObjectArgument:
   Enabled: true
 
-RequireParentheses:
+Lint/HandleExceptions:
   Enabled: true
 
-UnderscorePrefixedVariableName:
+Lint/LiteralInCondition:
+  Description: Checks of literals used in conditions.
   Enabled: true
 
-Void:
+Lint/LiteralInInterpolation:
+  Description: Checks for literals used in interpolation.
   Enabled: true

data/.rubocop.yml

@@ -1,9 +1,20 @@
 inherit_from:
   - .rubocop.unhound.yml
 
+AllCops:
+  Include:
+    - '**/Gemfile'
+    - '**/Rakefile'
+  Exclude:
+   - 'vendor/bundle/**/*'
+  TargetRubyVersion: 2.1
+
 Metrics/LineLength:
   Max: 100
 
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact
+
 Style/DotPosition:
   EnforcedStyle: trailing
 
@@ -13,9 +24,18 @@ Style/Documentation:
 Style/IndentHash:
   EnforcedStyle: consistent
 
+Style/IfUnlessModifier:
+  MaxLineLength: 100
+
+Style/ParallelAssignment:
+  Enabled: false
+
 Style/StringLiterals:
   EnforcedStyle: single_quotes
 
+Style/WhileUntilModifier:
+  MaxLineLength: 100
+
 Style/WordArray:
   Enabled: false
 

data/.travis.yml

@@ -1,8 +1,9 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.1.7
-  - 2.2.3
+  - 2.1.8
+  - 2.2.4
+  - 2.3.0
   - ruby-head
 matrix:
   allow_failures:

data/README.md

@@ -3,3 +3,30 @@
 
 This is the library common between the web application and the evaluator for determining the 
 programming languages supported in Coursemology.
+
+## Usage
+### With Rails
+The library works with Railties, so there is no special configuration.
+
+The gem provides a JavaScript asset which can be used to require all Ace modes that are needed by
+all concrete languages. In your application manifest, include this:
+
+```javascript
+//= require coursemology/polyglot/ace-modes
+```
+
+Ensure that Ace is found within the `ace` directory (i.e. `ace/mode-python.js` etc.)
+
+### Without Rails
+In your `Gemfile`:
+```ruby
+gem 'coursemology-polyglot'
+```
+
+Then, in your application:
+```ruby
+Coursemology::Polyglot.eager_load!
+```
+
+The Polyglot library needs to be eager loaded so that it knows which languages are defined. 
+Otherwise, the list of `concrete_languages` will be empty.

data/app/assets/javascripts/coursemology/polyglot/ace-modes.js.erb

@@ -0,0 +1,5 @@
+<%
+Coursemology::Polyglot::Language.concrete_languages.map(&:ace_mode).uniq.each do |ace_mode|
+  require_asset "ace/mode-#{ace_mode}"
+end
+%>

data/coursemology-polyglot.gemspec

@@ -29,4 +29,8 @@ programming languages supported in Coursemology.
   spec.add_development_dependency 'codeclimate-test-reporter'
 
   spec.add_dependency 'activesupport', '~> 4.2.0', '>= 4.2.2'
+
+  # For autoloading in Rails applications, as well as the Ace modes inclusion. Keep this as the
+  # same as ActiveSupport version.
+  spec.add_development_dependency 'railties', '~> 4.2.0', '>= 4.2.2'
 end

data/lib/coursemology/polyglot.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
 require 'active_support/all'
 require 'coursemology/polyglot/version'
+require 'coursemology/polyglot/engine' if defined?(Rails)
 
 module Coursemology::Polyglot
   extend ActiveSupport::Autoload

data/lib/coursemology/polyglot/concrete_language.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This module is included when a Language can be directly used by the user.
 #
 # This is deliberately defined so that consumers of this library can inject methods into all

data/lib/coursemology/polyglot/concrete_language/class_methods.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This module is extended by the language's singleton class when the Language can be directly used
 # by the user.
 #

data/lib/coursemology/polyglot/engine.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+class Coursemology::Polyglot::Engine < Rails::Engine
+  def self.eager_load!
+    super
+    Coursemology::Polyglot.eager_load!
+  end
+
+  # :nocov:
+  # These are Railties callbacks, which we can't trigger in specs specifically.
+  def self.initialize_engine(_)
+    Coursemology::Polyglot::Language.eager_load!
+  end
+
+  def self.after_initialize(_)
+    return if !Coursemology::Polyglot::Language.connected? ||
+              !Coursemology::Polyglot::Language.table_exists?
+
+    Coursemology::Polyglot::Language.load_languages
+  end
+  # :nocov:
+
+  initializer('coursemology.polyglot', &method(:initialize_engine))
+  config.after_initialize(&method(:after_initialize))
+end

data/lib/coursemology/polyglot/language.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 if defined?(ActiveRecord)
   # :nocov:
   # TODO: This is for compatibility with the Web application. A future refactoring might be able
@@ -45,6 +46,7 @@ class Coursemology::Polyglot::Language
 
     extend concrete_class_methods
   end
+  private_class_method :concrete_language
 
   # Determines the concrete language subclasses of this language.
   #
@@ -55,6 +57,31 @@ class Coursemology::Polyglot::Language
     end
   end
 
+  # The name of the lexer or mode to use with a given library. This is inherited by classes.
+  #
+  # @param [String|nil] default The default lexer/mode to use for each library.
+  # @param [String] rouge The overridden lexer to use for Rouge. This is optional and will
+  #   default to +default+
+  # @param [String] ace The overridden mode to use for Ace. This is optional and will
+  #   default to +default+
+  # @raise [ArgumentError] When no default is specified and the Rouge lexer or Ace mode is not
+  #   specified.
+  def self.syntax_highlighter(default = nil, rouge: default, ace: default)
+    fail ArgumentError unless rouge && ace
+
+    syntax_highlighter_class_methods = Module.new do
+      define_method(:rouge_lexer) { rouge }
+      define_method(:ace_mode) { ace }
+    end
+    extend syntax_highlighter_class_methods
+
+    syntax_highlighter_instance_methods = Module.new do
+      delegate :rouge_lexer, :ace_mode, to: :class
+    end
+    include syntax_highlighter_instance_methods
+  end
+  private_class_method :syntax_highlighter
+
   # Gets the display name of the language.
   #
   # @abstract
@@ -63,23 +90,19 @@ class Coursemology::Polyglot::Language
     fail NotImplementedError
   end
 
-  # The stylesheets that need to be packaged with the rest of the application.
-  #
-  # This should include the Rouge/Pygments stylesheet for formatting code.
+  # The Rouge lexer to use with this language.
   #
   # @abstract
-  # @return [Array<String>]
-  def self.stylesheets
+  # @return [String]
+  def self.rouge_lexer
     fail NotImplementedError
   end
 
-  # The script files that need to be packaged with the rest of the application.
-  #
-  # This should include the Ace mode for the language.
+  # The Ace mode to use with this language.
   #
   # @abstract
-  # @return [Array<String>]
-  def self.javascript
+  # @return [String]
+  def self.ace_mode
     fail NotImplementedError
   end
 end

data/lib/coursemology/polyglot/language/python.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
 class Coursemology::Polyglot::Language::Python < Coursemology::Polyglot::Language
+  syntax_highlighter 'python'
+
   class Python2Point7 < Coursemology::Polyglot::Language::Python
     concrete_language 'Python 2.7', docker_image: 'python:2.7'
   end

data/lib/coursemology/polyglot/version.rb

@@ -1,4 +1,5 @@
+# frozen_string_literal: true
 module Coursemology; end
 module Coursemology::Polyglot
-  VERSION = '0.0.3'
+  VERSION = '0.1.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coursemology-polyglot
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Joel Low
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-19 00:00:00.000000000 Z
+date: 2016-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -114,6 +114,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.2.2
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.2
 description: |
   Common definitions shared between the web application and the evaluator for determining the
   programming languages supported in Coursemology.
@@ -133,10 +153,12 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- app/assets/javascripts/coursemology/polyglot/ace-modes.js.erb
 - coursemology-polyglot.gemspec
 - lib/coursemology/polyglot.rb
 - lib/coursemology/polyglot/concrete_language.rb
 - lib/coursemology/polyglot/concrete_language/class_methods.rb
+- lib/coursemology/polyglot/engine.rb
 - lib/coursemology/polyglot/language.rb
 - lib/coursemology/polyglot/language/python.rb
 - lib/coursemology/polyglot/version.rb
@@ -160,7 +182,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Coursemology polyglot definitions