cog 0.2.1 → 0.2.2

data/lib/cog/languages/c_language.rb

@@ -1,31 +1,17 @@
 require 'cog/languages/language'
+require 'cog/languages/mixins/c_style_comments'
 
 module Cog
   module Languages
     
     class CLanguage < Language
-
-      # @param nested_pattern [String] regular expression pattern (as a string) to embed in the regular expression which matches one line comments in this language
-      # @return [Regexp] pattern for matching one line comments in this language
-      def comment_pattern(nested_pattern)
-        /^\s*(?:\/\/|\/\*)\s*#{nested_pattern}\s*(?:\*\/)?\s*$/i
-      end
+      include Mixins::CStyleComments
 
       # @return [Array<String>] a set of extensions needed to define a module in this language
       def module_extensions
         [:c, :h]
       end
-      
-      # @return [String] ignored in c
-      def named_scope_begin(name)
-        ""
-      end
-
-      # @return [String] ignored in c
-      def named_scope_end(name)
-        ""
-      end
-      
+            
       # @param name [String] name of the module to protect
       # @return [String] an include guard statement
       def include_guard_begin(name)
@@ -38,16 +24,6 @@ module Cog
         "#endif // #{name}"
       end
 
-      protected
-      
-      def one_line_comment(text)
-        "// #{text}"
-      end
-      
-      def multi_line_comment(text)
-        "/*\n#{text}\n */"
-      end
-
     end
   end
 end

data/lib/cog/languages/c_plus_plus_language.rb

@@ -1,29 +1,24 @@
 require 'cog/languages/c_language'
+require 'cog/languages/mixins/c_style_comments'
 
 module Cog
   module Languages
     
-    class CPlusPlusLanguage < CLanguage
+    class CPlusPlusLanguage < Language
+      include Mixins::CStyleComments
 
-      # @return [Array<String>] a set of extensions needed to define a module in this language
       def module_extensions
         [:cpp, :hpp]
       end
       
-      # @param name [String] name of the scope to use
-      # @return [String] a using statement for the named scope
       def use_named_scope(name)
         "using namespace #{name};"
       end
 
-      # @param name [String] name of the scope
-      # @return [String] begin a named scope
       def named_scope_begin(name)
         "namespace #{name} {"
       end
 
-      # @param name [String] name of the scope
-      # @return [String] end the given named scope
       def named_scope_end(name)
         "} // namespace #{name}"
       end

data/lib/cog/languages/c_sharp_language.rb

@@ -1,37 +1,24 @@
 require 'cog/languages/c_language'
+require 'cog/languages/mixins/c_style_comments'
 
 module Cog
   module Languages
     
-    class CSharpLanguage < CLanguage
+    class CSharpLanguage < Language
+      include Mixins::CStyleComments
 
-      # @return [Array<String>] a set of extensions needed to define a module in this language
       def module_extensions
         [:cs]
       end
       
-      # @param name [String] name of the scope
-      # @return [String] begin a named scope
       def named_scope_begin(name)
         "namespace #{name} {"
       end
 
-      # @param name [String] name of the scope
-      # @return [String] end the given named scope
       def named_scope_end(name)
         "} // namespace #{name}"
       end
       
-      # @return [String] ignored for c#
-      def include_guard_begin(name)
-        ""
-      end
-      
-      # @return [String] ignored for c#
-      def include_guard_end(name)
-        ""
-      end
-
     end
   end
 end

data/lib/cog/languages/java_language.rb

@@ -1,37 +1,24 @@
 require 'cog/languages/c_language'
+require 'cog/languages/mixins/c_style_comments'
 
 module Cog
   module Languages
     
-    class JavaLanguage < CLanguage
+    class JavaLanguage < Language
+      include Mixins::CStyleComments
 
-      # @return [Array<String>] a set of extensions needed to define a module in this language
       def module_extensions
         [:java]
       end
       
-      # @param name [String] name of the scope
-      # @return [String] begin a named scope
       def named_scope_begin(name)
         "package #{name};"
       end
 
-      # @param name [String] name of the scope
-      # @return [String] end the given named scope
       def named_scope_end(name)
         "// end of package: #{name}"
       end
       
-      # @return [String] ignored for java
-      def include_guard_begin(name)
-        ""
-      end
-      
-      # @return [String] ignored for java
-      def include_guard_end(name)
-        ""
-      end
-
     end
   end
 end

data/lib/cog/languages/java_script_language.rb

@@ -1,36 +1,23 @@
 require 'cog/languages/c_language'
+require 'cog/languages/mixins/c_style_comments'
 
 module Cog
   module Languages
     
-    class JavaScriptLanguage < CLanguage
+    class JavaScriptLanguage < Language
+      include Mixins::CStyleComments
 
-      # @return [Array<String>] a set of extensions needed to define a module in this language
       def module_extensions
         [:js]
       end
       
-      # @param name [String] name of the scope
-      # @return [String] begin a named scope
       def named_scope_begin(name)
         "var #{name} = { // named scope"
       end
 
-      # @param name [String] name of the scope
-      # @return [String] end the given named scope
       def named_scope_end(name)
         "}; // named scope: #{name}"
       end
-      
-      # @return [String] ignored for javascript
-      def include_guard_begin(name)
-        ""
-      end
-      
-      # @return [String] ignored for javascript
-      def include_guard_end(name)
-        ""
-      end
 
     end
   end

data/lib/cog/languages/language.rb

@@ -20,6 +20,18 @@ module Cog
           one_line_comment text
         end
       end
+
+      # @api developer
+      def one_line_comment(text)
+        text
+      end
+      
+      # @api developer
+      def multi_line_comment(text)
+        text.split("\n").collect do |line|
+          one_line_comment line
+        end.join "\n"
+      end
       
       # @return [Array<String>] a set of extensions needed to define a module in this language
       def module_extensions
@@ -56,18 +68,6 @@ module Cog
         ""
       end
 
-      protected
-      
-      def one_line_comment(text)
-        text
-      end
-      
-      def multi_line_comment(text)
-        text.split("\n").collect do |line|
-          one_line_comment line
-        end.join "\n"
-      end
-      
     end
   end
 end

data/lib/cog/languages/mixins.rb

@@ -0,0 +1,10 @@
+require 'cog/languages/mixins/c_style_comments'
+
+module Cog
+  module Languages
+    
+    # Place for mixins which define common patterns in language syntax
+    module Mixins
+    end
+  end
+end

data/lib/cog/languages/mixins/c_style_comments.rb

@@ -0,0 +1,23 @@
+module Cog
+  module Languages
+    module Mixins
+      
+      # Methods for defining single and multiline c-style comments
+      module CStyleComments
+        
+        def comment_pattern(nested_pattern)
+          /^\s*(?:\/\/|\/\*)\s*#{nested_pattern}\s*(?:\*\/)?\s*$/i
+        end
+
+        def one_line_comment(text)
+          "// #{text}"
+        end
+      
+        def multi_line_comment(text)
+          "/*\n#{text}\n */"
+        end
+        
+      end
+    end
+  end
+end

data/lib/cog/languages/mixins/hash_comments.rb

@@ -0,0 +1,19 @@
+module Cog
+  module Languages
+    module Mixins
+      
+      # Methods for defining single line comments that begin with a hash (<tt>#</tt>)
+      module HashComments
+        
+        def comment_pattern(nested_pattern)
+          /^\s*\#\s*#{nested_pattern}\s*$/i
+        end
+
+        def one_line_comment(text)
+          "# #{text}"
+        end
+      
+      end
+    end
+  end
+end

data/lib/cog/languages/python_language.rb

@@ -1,47 +1,16 @@
 require 'cog/languages/language'
+require 'cog/languages/mixins/hash_comments'
 
 module Cog
   module Languages
     
     class PythonLanguage < Language
+      include Mixins::HashComments
 
-      # @param nested_pattern [String] regular expression pattern (as a string) to embed in the regular expression which matches one line comments in this language
-      # @return [Regexp] pattern for matching one line comments in this language
-      def comment_pattern(nested_pattern)
-        /^\s*\#\s*#{nested_pattern}\s*$/i
-      end
-
-      # @return [Array<String>] a set of extensions needed to define a module in this language
       def module_extensions
         [:py]
       end
       
-      # @return [String] ignored for python
-      def named_scope_begin(name)
-        ""
-      end
-
-      # @return [String] ignored for python
-      def named_scope_end(name)
-        ""
-      end
-      
-      # @return [String] ignored for python
-      def include_guard_begin(name)
-        ""
-      end
-      
-      # @return [String] ignored for python
-      def include_guard_end(name)
-        ""
-      end
-
-      protected
-      
-      def one_line_comment(text)
-        "# #{text}"
-      end
-      
       def multi_line_comment(text)
         "'''\n#{text}\n'''"
       end

data/lib/cog/languages/qt_project_language.rb

@@ -1,45 +1,14 @@
 require 'cog/languages/language'
+require 'cog/languages/mixins/hash_comments'
 
 module Cog
   module Languages
     
     class QtProjectLanguage < Language
+      include Mixins::HashComments
 
-      # @param nested_pattern [String] regular expression pattern (as a string) to embed in the regular expression which matches one line comments in this language
-      # @return [Regexp] pattern for matching one line comments in this language
-      def comment_pattern(nested_pattern)
-        /^\s*\#\s*#{nested_pattern}\s*$/i
-      end
-
-      # @return [Array<String>] a set of extensions needed to define a module in this language
       def module_extensions
-        [:pro]
-      end
-      
-      # @return [String] ignored for Qt Project files
-      def named_scope_begin(name)
-        ""
-      end
-
-      # @return [String] ignored for Qt Project files
-      def named_scope_end(name)
-        ""
-      end
-      
-      # @return [String] ignored for Qt Project files
-      def include_guard_begin(name)
-        ""
-      end
-      
-      # @return [String] ignored for Qt Project files
-      def include_guard_end(name)
-        ""
-      end
-
-      protected
-      
-      def one_line_comment(text)
-        "# #{text}"
+        [:pro, :pri]
       end
       
     end

data/lib/cog/languages/ruby_language.rb

@@ -1,53 +1,28 @@
 require 'cog/languages/language'
+require 'cog/languages/mixins/hash_comments'
 
 module Cog
   module Languages
     
     class RubyLanguage < Language
+      include Mixins::HashComments
 
-      # @param nested_pattern [String] regular expression pattern (as a string) to embed in the regular expression which matches one line comments in this language
-      # @return [Regexp] pattern for matching one line comments in this language
-      def comment_pattern(nested_pattern)
-        /^\s*\#\s*#{nested_pattern}\s*$/i
-      end
-
-      # @return [Array<String>] a set of extensions needed to define a module in this language
       def module_extensions
         [:rb]
       end
       
-      # @param name [String] name of the scope
-      # @return [String] begin a named scope
+      def multi_line_comment(text)
+        "=begin\n#{text}\n=end"
+      end
+
       def named_scope_begin(name)
         "module #{name}"
       end
 
-      # @param name [String] name of the scope
-      # @return [String] end the given named scope
       def named_scope_end(name)
         "end # module #{name}"
       end
       
-      # @return [String] ignored for ruby
-      def include_guard_begin(name)
-        ""
-      end
-      
-      # @return [String] ignored for ruby
-      def include_guard_end(name)
-        ""
-      end
-
-      protected
-      
-      def one_line_comment(text)
-        "# #{text}"
-      end
-      
-      def multi_line_comment(text)
-        "=begin\n#{text}\n=end"
-      end
-
     end
   end
 end