inch 0.5.10 → 0.6.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 72f3a96a1d7027c5f7e4f02377a3d2c7e6ab0483
-  data.tar.gz: 9d37e5e3c38c2cd9e2e73a8d4346bc14056b9d01
+  metadata.gz: 2576ec3e34a40dd71b8a98c24d99a2a221774b5a
+  data.tar.gz: d5a9dc7b201840df3ebbc34f8ad5ab87ad0552d9
 SHA512:
-  metadata.gz: c1c444e52a2a5c52b488fda70e7fe7d2997fdee57e23003964134f4d32c4e700e2ad711a9ae4ffb4fc028b266f82635a13f72039d0a0ad5114166f38e30d1aa8
-  data.tar.gz: b634cae70beb91a1c6675d0cdac62bf6011a0b756476a04eee564808e32c5662a7403264ad6ceeb39c4b50e273d3a7b159187be00ce80c675b688794c61d10b9
+  metadata.gz: d4598a0be0972ccc7205f4a9dbde89ba86b61d7547c979ad1e7f4ef16fa7ef4f566c80c458c454302ef1252c48a5284356e9d34bc0b598a67e166a4e90ec9bc3
+  data.tar.gz: 6af39b0a5f329493e57bff20bec65f1a7eb84025a78aa4b24bfbe47b39156a065324be3ff0a5c99423e859da432a18db89fd104800debc59bb37a8419a9d0062

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.6.0
+
+- NodeJS is renamed to JavaScript, which breaks backwards compatibility
+
 ## 0.5.9
 
 - NodeJS: Improve output of code object names and locations

data/config/{nodejs.rb → javascript.rb}

@@ -1,7 +1,6 @@
-# NodeJS's configuration
-# Node will be treated as a separate programming language for now
+# JavaScript's configuration
 
-Inch::Config.register(:nodejs) do
+Inch::Config.register(:javascript) do
   codebase do
     object_provider :JSDoc
     include_files   ['src/**/*.js']

data/lib/inch.rb

@@ -16,5 +16,5 @@ require 'inch/language'
 require 'inch/config'
 require File.join(File.dirname(__FILE__), '..', 'config', 'base.rb')
 require File.join(File.dirname(__FILE__), '..', 'config', 'ruby.rb')
-require File.join(File.dirname(__FILE__), '..', 'config', 'nodejs.rb')
+require File.join(File.dirname(__FILE__), '..', 'config', 'javascript.rb')
 require File.join(File.dirname(__FILE__), '..', 'config', 'elixir.rb')

data/lib/inch/cli/command/options/base.rb

@@ -130,7 +130,7 @@ module Inch
               exit
             end
             opts.on_tail('-l', '--language [LANGUAGE]',
-                         'Set language (elixir|nodejs|ruby).') do |language|
+                         'Set language (elixir|javascript|ruby).') do |language|
               @language = language
             end
             opts.on_tail('-r', '--read-from-dump [FILE]',

data/lib/inch/cli/command/output/base.rb

@@ -19,7 +19,7 @@ module Inch
           include TraceHelper
 
           def display_name(object)
-            if object.language == :nodejs
+            if object.language == :javascript
               object.fullname+" in #{object.filename.relative_path}".color(:dark)
             else
               object.fullname

data/lib/inch/config.rb

@@ -41,8 +41,10 @@ module Inch
       end
 
       def namespace(language, submodule = nil)
-        name = language.to_s.split('_').map { |w| w.capitalize }.join
-        const = ::Inch::Language.const_get(name)
+        const_name = ::Inch::Language.constants.detect do |name|
+          name.to_s.downcase == language.to_s.downcase
+        end
+        const = ::Inch::Language.const_get(const_name)
         const = const.const_get(submodule) unless submodule.nil?
         const
       end

data/lib/inch/language.rb

@@ -1,3 +1,3 @@
 require 'inch/language/ruby/import'
 require 'inch/language/elixir/import'
-require 'inch/language/nodejs/import'
+require 'inch/language/javascript/import'

data/lib/inch/language/{nodejs → javascript}/code_object/base.rb

@@ -2,7 +2,7 @@ require 'forwardable'
 
 module Inch
   module Language
-    module Nodejs
+    module JavaScript
       # This is the base class for code object proxies.
       # Code object proxies are via an attributes Hash and provide all methods
       # necessary for the evaluation of its documentation.
@@ -11,7 +11,7 @@ module Inch
       module CodeObject
         class Base < Inch::CodeObject::Proxy
           def language
-            :nodejs
+            :javascript
           end
 
           # @return [Boolean] if the current object is an alias for something

data/lib/inch/language/{nodejs → javascript}/code_object/class_object.rb

@@ -1,6 +1,6 @@
 module Inch
   module Language
-    module Nodejs
+    module JavaScript
       module CodeObject
         # Proxy class for modules
         class ClassObject < ModuleObject

data/lib/inch/language/{nodejs → javascript}/code_object/function_object.rb

@@ -1,8 +1,8 @@
-require 'inch/language/nodejs/code_object/function_parameter_object'
+require 'inch/language/javascript/code_object/function_parameter_object'
 
 module Inch
   module Language
-    module Nodejs
+    module JavaScript
       module CodeObject
         # Proxy class for functions
         class FunctionObject < Base

data/lib/inch/language/{nodejs → javascript}/code_object/function_parameter_object.rb

@@ -1,6 +1,6 @@
 module Inch
   module Language
-    module Nodejs
+    module JavaScript
       module CodeObject
         # Proxy class for method parameters
         class FunctionParameterObject

data/lib/inch/language/{nodejs → javascript}/code_object/member_object.rb

@@ -1,6 +1,6 @@
 module Inch
   module Language
-    module Nodejs
+    module JavaScript
       module CodeObject
         # Proxy class for types
         class MemberObject < Base

data/lib/inch/language/{nodejs → javascript}/code_object/module_object.rb

@@ -1,6 +1,6 @@
 module Inch
   module Language
-    module Nodejs
+    module JavaScript
       module CodeObject
         # Proxy class for modules
         class ModuleObject < Base

data/lib/inch/language/{nodejs → javascript}/evaluation/base.rb

@@ -1,8 +1,8 @@
 module Inch
   module Language
-    module Nodejs
+    module JavaScript
       module Evaluation
-        # Base class for all Nodejs related evaluations
+        # Base class for all JavaScript related evaluations
         #
         # @abstract
         class Base < Inch::Evaluation::Proxy

data/lib/inch/language/{nodejs → javascript}/evaluation/class_object.rb

@@ -1,6 +1,6 @@
 module Inch
   module Language
-    module Nodejs
+    module JavaScript
       module Evaluation
         # Proxy class for classes
         class ClassObject < ModuleObject

data/lib/inch/language/{nodejs → javascript}/evaluation/function_object.rb

@@ -1,6 +1,6 @@
 module Inch
   module Language
-    module Nodejs
+    module JavaScript
       module Evaluation
         # Proxy class for functions
         class FunctionObject < Base

data/lib/inch/language/{nodejs → javascript}/evaluation/member_object.rb

@@ -1,6 +1,6 @@
 module Inch
   module Language
-    module Nodejs
+    module JavaScript
       module Evaluation
         # Proxy class for types
         class MemberObject < Base

data/lib/inch/language/{nodejs → javascript}/evaluation/module_object.rb

@@ -1,6 +1,6 @@
 module Inch
   module Language
-    module Nodejs
+    module JavaScript
       module Evaluation
         # Proxy class for modules
         class ModuleObject < Base

data/lib/inch/language/javascript/import.rb

@@ -0,0 +1,27 @@
+module Inch
+  module Language
+    module JavaScript
+    end
+  end
+end
+
+require 'inch/language/javascript/provider/jsdoc'
+
+require 'inch/language/javascript/code_object/base'
+require 'inch/language/javascript/code_object/module_object'
+require 'inch/language/javascript/code_object/class_object'
+require 'inch/language/javascript/code_object/function_object'
+require 'inch/language/javascript/code_object/member_object'
+
+require 'inch/language/javascript/evaluation/base'
+require 'inch/language/javascript/evaluation/module_object'
+require 'inch/language/javascript/evaluation/class_object'
+require 'inch/language/javascript/evaluation/function_object'
+require 'inch/language/javascript/evaluation/member_object'
+
+require 'inch/language/javascript/roles/base'
+require 'inch/language/javascript/roles/object'
+require 'inch/language/javascript/roles/module'
+require 'inch/language/javascript/roles/function'
+require 'inch/language/javascript/roles/function_parameter'
+require 'inch/language/javascript/roles/member'

data/lib/inch/language/{nodejs → javascript}/provider/jsdoc.rb

@@ -2,7 +2,7 @@ require 'json'
 
 module Inch
   module Language
-    module Nodejs
+    module JavaScript
       module Provider
         # Parses the source tree (using JSDoc)
         module JSDoc
@@ -16,4 +16,4 @@ module Inch
   end
 end
 
-require 'inch/language/nodejs/provider/jsdoc/parser'
+require 'inch/language/javascript/provider/jsdoc/parser'

data/lib/inch/language/{nodejs → javascript}/provider/jsdoc/docstring.rb

@@ -1,7 +1,7 @@
 
 module Inch
   module Language
-    module Nodejs
+    module JavaScript
       module Provider
         module JSDoc
           class Docstring < Ruby::Provider::YARD::Docstring

data/lib/inch/language/{nodejs → javascript}/provider/jsdoc/object.rb

@@ -1,12 +1,12 @@
-require 'inch/language/nodejs/provider/jsdoc/object/base'
-require 'inch/language/nodejs/provider/jsdoc/object/function_object'
-require 'inch/language/nodejs/provider/jsdoc/object/module_object'
-require 'inch/language/nodejs/provider/jsdoc/object/class_object'
-require 'inch/language/nodejs/provider/jsdoc/object/member_object'
+require 'inch/language/javascript/provider/jsdoc/object/base'
+require 'inch/language/javascript/provider/jsdoc/object/function_object'
+require 'inch/language/javascript/provider/jsdoc/object/module_object'
+require 'inch/language/javascript/provider/jsdoc/object/class_object'
+require 'inch/language/javascript/provider/jsdoc/object/member_object'
 
 module Inch
   module Language
-    module Nodejs
+    module JavaScript
       module Provider
         module JSDoc
           # CodeObject::Provider::JSDoc::Object object represent code objects.

data/lib/inch/language/{nodejs → javascript}/provider/jsdoc/object/base.rb

@@ -1,9 +1,9 @@
-require 'inch/language/nodejs/provider/jsdoc/docstring'
+require 'inch/language/javascript/provider/jsdoc/docstring'
 require 'inch/utils/code_location'
 
 module Inch
   module Language
-    module Nodejs
+    module JavaScript
       module Provider
         module JSDoc
           module Object

data/lib/inch/language/{nodejs → javascript}/provider/jsdoc/object/class_object.rb

@@ -1,6 +1,6 @@
 module Inch
   module Language
-    module Nodejs
+    module JavaScript
       module Provider
         module JSDoc
           module Object

data/lib/inch/language/{nodejs → javascript}/provider/jsdoc/object/function_object.rb

@@ -1,8 +1,8 @@
-require 'inch/language/nodejs/provider/jsdoc/object/function_parameter_object'
+require 'inch/language/javascript/provider/jsdoc/object/function_parameter_object'
 
 module Inch
   module Language
-    module Nodejs
+    module JavaScript
       module Provider
         module JSDoc
           module Object

data/lib/inch/language/{nodejs → javascript}/provider/jsdoc/object/function_parameter_object.rb

@@ -1,6 +1,6 @@
 module Inch
   module Language
-    module Nodejs
+    module JavaScript
       module Provider
         module JSDoc
           module Object

data/lib/inch/language/{nodejs → javascript}/provider/jsdoc/object/member_object.rb

@@ -1,6 +1,6 @@
 module Inch
   module Language
-    module Nodejs
+    module JavaScript
       module Provider
         module JSDoc
           module Object

data/lib/inch/language/{nodejs → javascript}/provider/jsdoc/object/module_object.rb

@@ -1,6 +1,6 @@
 module Inch
   module Language
-    module Nodejs
+    module JavaScript
       module Provider
         module JSDoc
           module Object

data/lib/inch/language/{nodejs → javascript}/provider/jsdoc/parser.rb

@@ -1,9 +1,9 @@
 require 'json'
-require 'inch/language/nodejs/provider/jsdoc/object'
+require 'inch/language/javascript/provider/jsdoc/object'
 
 module Inch
   module Language
-    module Nodejs
+    module JavaScript
       module Provider
         module JSDoc
           # Parses the source tree (using JSDoc)
@@ -45,7 +45,7 @@ module Inch
 
             def parse_objects(_paths, _excluded, read_dump_file = nil)
               if read_dump_file.nil?
-                fail 'NodeJS analysis only works with --read-from-dump.'
+                fail 'JavaScript analysis only works with --read-from-dump.'
               else
                 output = File.read(read_dump_file, :encoding => 'utf-8')
               end

data/lib/inch/language/{nodejs → javascript}/roles/base.rb

@@ -1,6 +1,6 @@
 module Inch
   module Language
-    module Nodejs
+    module JavaScript
       module Evaluation
         module Role
           # @abstract

data/lib/inch/language/{nodejs → javascript}/roles/function.rb

@@ -1,6 +1,6 @@
 module Inch
   module Language
-    module Nodejs
+    module JavaScript
       module Evaluation
         module Role
           module Function

data/lib/inch/language/{nodejs → javascript}/roles/function_parameter.rb

@@ -1,6 +1,6 @@
 module Inch
   module Language
-    module Nodejs
+    module JavaScript
       module Evaluation
         module Role
           # Roles assigned to method parameters

data/lib/inch/language/{nodejs → javascript}/roles/member.rb

@@ -1,6 +1,6 @@
 module Inch
   module Language
-    module Nodejs
+    module JavaScript
       module Evaluation
         module Role
           # Roles assigned to members

data/lib/inch/language/{nodejs → javascript}/roles/module.rb

@@ -1,6 +1,6 @@
 module Inch
   module Language
-    module Nodejs
+    module JavaScript
       module Evaluation
         module Role
           # Roles assigned to modules

data/lib/inch/language/{nodejs → javascript}/roles/object.rb

@@ -1,6 +1,6 @@
 module Inch
   module Language
-    module Nodejs
+    module JavaScript
       module Evaluation
         module Role
           # Roles assigned to all objects

data/lib/inch/version.rb

@@ -1,3 +1,3 @@
 module Inch
-  VERSION = '0.5.10'
+  VERSION = '0.6.0.rc1'
 end

data/test/fixtures/{nodejs → javascript}/inch_test/all.json

@@ -1,252 +1,252 @@
 {
-    "args": [], 
-    "branch_name": "master", 
-    "client_name": "inchjs", 
-    "client_version": "0.1.4", 
-    "git_repo_url": "git@github.com:inch-ci/Hello-World-NodeJS.git", 
-    "language": "nodejs", 
+    "args": [],
+    "branch_name": "master",
+    "client_name": "inchjs",
+    "client_version": "0.1.4",
+    "git_repo_url": "git@github.com:inch-ci/Hello-World-NodeJS.git",
+    "language": "javascript",
     "objects": [
         {
-            "comment": "", 
-            "kind": "function", 
-            "longname": "InstanciatableClass", 
+            "comment": "",
+            "kind": "function",
+            "longname": "InstanciatableClass",
             "meta": {
                 "code": {
-                    "id": "astnode100000004", 
-                    "name": "InstanciatableClass", 
-                    "type": "FunctionExpression", 
+                    "id": "astnode100000004",
+                    "name": "InstanciatableClass",
+                    "type": "FunctionExpression",
                     "value": "function"
-                }, 
-                "filename": "inch_test.js", 
-                "lineno": 4, 
-                "path": "/src", 
+                },
+                "filename": "inch_test.js",
+                "lineno": 4,
+                "path": "/src",
                 "range": [
-                    20, 
+                    20,
                     55
                 ]
-            }, 
-            "name": "InstanciatableClass", 
-            "scope": "global", 
+            },
+            "name": "InstanciatableClass",
+            "scope": "global",
             "undocumented": true
-        }, 
+        },
         {
-            "comment": "", 
-            "kind": "function", 
-            "longname": "InstanciatableClass#render", 
-            "memberof": "InstanciatableClass", 
+            "comment": "",
+            "kind": "function",
+            "longname": "InstanciatableClass#render",
+            "memberof": "InstanciatableClass",
             "meta": {
                 "code": {
-                    "id": "astnode100000009", 
-                    "name": "InstanciatableClass.prototype.render", 
-                    "paramnames": [], 
-                    "type": "FunctionExpression", 
+                    "id": "astnode100000009",
+                    "name": "InstanciatableClass.prototype.render",
+                    "paramnames": [],
+                    "type": "FunctionExpression",
                     "value": "function"
-                }, 
-                "filename": "inch_test.js", 
-                "lineno": 5, 
-                "path": "/src", 
+                },
+                "filename": "inch_test.js",
+                "lineno": 5,
+                "path": "/src",
                 "range": [
-                    57, 
+                    57,
                     125
                 ]
-            }, 
-            "name": "render", 
-            "scope": "instance", 
+            },
+            "name": "render",
+            "scope": "instance",
             "undocumented": true
-        }, 
+        },
         {
-            "access": "private", 
-            "comment": "/**\n* @private\n*/", 
-            "kind": "function", 
-            "longname": "InchTest.generate_docs", 
-            "memberof": "InchTest", 
+            "access": "private",
+            "comment": "/**\n* @private\n*/",
+            "kind": "function",
+            "longname": "InchTest.generate_docs",
+            "memberof": "InchTest",
             "meta": {
                 "code": {
-                    "id": "astnode100000024", 
-                    "name": "InchTest.generate_docs", 
+                    "id": "astnode100000024",
+                    "name": "InchTest.generate_docs",
                     "paramnames": [
-                        "project", 
-                        "version", 
-                        "args", 
+                        "project",
+                        "version",
+                        "args",
                         "options"
-                    ], 
-                    "type": "FunctionExpression", 
+                    ],
+                    "type": "FunctionExpression",
                     "value": "function"
-                }, 
-                "filename": "inch_test.js", 
-                "lineno": 13, 
-                "path": "/src", 
+                },
+                "filename": "inch_test.js",
+                "lineno": 13,
+                "path": "/src",
                 "range": [
-                    165, 
+                    165,
                     236
                 ]
-            }, 
-            "name": "generate_docs", 
+            },
+            "name": "generate_docs",
             "scope": "static"
-        }, 
+        },
         {
-            "comment": "// Generate JSON documentation for the given modules", 
-            "kind": "function", 
-            "longname": "InchTest.Docs.Formatter.run", 
-            "memberof": "InchTest.Docs.Formatter", 
+            "comment": "// Generate JSON documentation for the given modules",
+            "kind": "function",
+            "longname": "InchTest.Docs.Formatter.run",
+            "memberof": "InchTest.Docs.Formatter",
             "meta": {
                 "code": {
-                    "id": "astnode100000042", 
-                    "name": "run", 
-                    "type": "FunctionExpression", 
+                    "id": "astnode100000042",
+                    "name": "run",
+                    "type": "FunctionExpression",
                     "value": "function"
-                }, 
-                "filename": "inch_test.js", 
-                "lineno": 19, 
-                "path": "/src", 
+                },
+                "filename": "inch_test.js",
+                "lineno": 19,
+                "path": "/src",
                 "range": [
-                    333, 
+                    333,
                     398
                 ]
-            }, 
-            "name": "run", 
-            "scope": "static", 
+            },
+            "name": "run",
+            "scope": "static",
             "undocumented": true
-        }, 
+        },
         {
-            "comment": "/**\n*\n* This function takes `param1` and `param2` as arguments.\n*\n* @param {Number} param1 A number from 0 to 26 that will result in a letter a-z\n* @param {String} param2 A text\n* @return {String} A character from a-z based on the input number n\n*\n* Examples:\n*\n*   > InchTest.Naming.resource_name(MyApp.User)\n*   \"user\"\n*   > InchTest.Naming.resource_name(MyApp.UserView, \"View\")\n*   \"user\"\n*/", 
-            "description": "This function takes `param1` and `param2` as arguments.", 
-            "kind": "function", 
-            "longname": "InchTest.Functions.full_doc", 
-            "memberof": "InchTest.Functions", 
+            "comment": "/**\n*\n* This function takes `param1` and `param2` as arguments.\n*\n* @param {Number} param1 A number from 0 to 26 that will result in a letter a-z\n* @param {String} param2 A text\n* @return {String} A character from a-z based on the input number n\n*\n* Examples:\n*\n*   > InchTest.Naming.resource_name(MyApp.User)\n*   \"user\"\n*   > InchTest.Naming.resource_name(MyApp.UserView, \"View\")\n*   \"user\"\n*/",
+            "description": "This function takes `param1` and `param2` as arguments.",
+            "kind": "function",
+            "longname": "InchTest.Functions.full_doc",
+            "memberof": "InchTest.Functions",
             "meta": {
                 "code": {
-                    "id": "astnode100000057", 
-                    "name": "InchTest.Functions.full_doc", 
+                    "id": "astnode100000057",
+                    "name": "InchTest.Functions.full_doc",
                     "paramnames": [
-                        "param1", 
+                        "param1",
                         "param2"
-                    ], 
-                    "type": "FunctionExpression", 
+                    ],
+                    "type": "FunctionExpression",
                     "value": "function"
-                }, 
-                "filename": "inch_test.js", 
-                "lineno": 41, 
-                "path": "/src", 
+                },
+                "filename": "inch_test.js",
+                "lineno": 41,
+                "path": "/src",
                 "range": [
-                    841, 
+                    841,
                     914
                 ]
-            }, 
-            "name": "full_doc", 
+            },
+            "name": "full_doc",
             "params": [
                 {
-                    "description": "A number from 0 to 26 that will result in a letter a-z", 
-                    "name": "param1", 
+                    "description": "A number from 0 to 26 that will result in a letter a-z",
+                    "name": "param1",
                     "type": {
                         "names": [
                             "Number"
                         ]
                     }
-                }, 
+                },
                 {
-                    "description": "A text", 
-                    "name": "param2", 
+                    "description": "A text",
+                    "name": "param2",
                     "type": {
                         "names": [
                             "String"
                         ]
                     }
                 }
-            ], 
+            ],
             "returns": [
                 {
-                    "description": "A character from a-z based on the input number n\n\nExamples:\n\n  > InchTest.Naming.resource_name(MyApp.User)\n  \"user\"\n  > InchTest.Naming.resource_name(MyApp.UserView, \"View\")\n  \"user\"", 
+                    "description": "A character from a-z based on the input number n\n\nExamples:\n\n  > InchTest.Naming.resource_name(MyApp.User)\n  \"user\"\n  > InchTest.Naming.resource_name(MyApp.UserView, \"View\")\n  \"user\"",
                     "type": {
                         "names": [
                             "String"
                         ]
                     }
                 }
-            ], 
+            ],
             "scope": "static"
-        }, 
+        },
         {
-            "comment": "/**\n*\n* This function takes a `param1` and a second parameter that is never used\n* (maybe, because it is a callback or something like that). However, the\n* second param should impact the evaluation by Inch.\n*\n* Examples:\n*\n*   > InchTest.Naming.resource_name(MyApp.User)\n*   \"user\"\n*   > InchTest.Naming.resource_name(MyApp.UserView, \"View\")\n*   \"user\"\n*/", 
-            "description": "This function takes a `param1` and a second parameter that is never used\n(maybe, because it is a callback or something like that). However, the\nsecond param should impact the evaluation by Inch.\n\nExamples:\n\n  > InchTest.Naming.resource_name(MyApp.User)\n  \"user\"\n  > InchTest.Naming.resource_name(MyApp.UserView, \"View\")\n  \"user\"", 
-            "kind": "function", 
-            "longname": "InchTest.Functions.full_doc_second_parameter_unnamed", 
-            "memberof": "InchTest.Functions", 
+            "comment": "/**\n*\n* This function takes a `param1` and a second parameter that is never used\n* (maybe, because it is a callback or something like that). However, the\n* second param should impact the evaluation by Inch.\n*\n* Examples:\n*\n*   > InchTest.Naming.resource_name(MyApp.User)\n*   \"user\"\n*   > InchTest.Naming.resource_name(MyApp.UserView, \"View\")\n*   \"user\"\n*/",
+            "description": "This function takes a `param1` and a second parameter that is never used\n(maybe, because it is a callback or something like that). However, the\nsecond param should impact the evaluation by Inch.\n\nExamples:\n\n  > InchTest.Naming.resource_name(MyApp.User)\n  \"user\"\n  > InchTest.Naming.resource_name(MyApp.UserView, \"View\")\n  \"user\"",
+            "kind": "function",
+            "longname": "InchTest.Functions.full_doc_second_parameter_unnamed",
+            "memberof": "InchTest.Functions",
             "meta": {
                 "code": {
-                    "id": "astnode100000070", 
-                    "name": "InchTest.Functions.full_doc_second_parameter_unnamed", 
+                    "id": "astnode100000070",
+                    "name": "InchTest.Functions.full_doc_second_parameter_unnamed",
                     "paramnames": [
-                        "param1", 
+                        "param1",
                         "_"
-                    ], 
-                    "type": "FunctionExpression", 
+                    ],
+                    "type": "FunctionExpression",
                     "value": "function"
-                }, 
-                "filename": "inch_test.js", 
-                "lineno": 57, 
-                "path": "/src", 
+                },
+                "filename": "inch_test.js",
+                "lineno": 57,
+                "path": "/src",
                 "range": [
-                    1271, 
+                    1271,
                     1364
                 ]
-            }, 
-            "name": "full_doc_second_parameter_unnamed", 
+            },
+            "name": "full_doc_second_parameter_unnamed",
             "scope": "static"
-        }, 
+        },
         {
-            "comment": "/**\n*\n* This function takes no arguments.\n*\n* Examples:\n*\n*   > InchTest.Naming.resource_name(MyApp.User)\n*   \"user\"\n*   > InchTest.Naming.resource_name(MyApp.UserView, \"View\")\n*   \"user\"\n*/", 
-            "description": "This function takes no arguments.\n\nExamples:\n\n  > InchTest.Naming.resource_name(MyApp.User)\n  \"user\"\n  > InchTest.Naming.resource_name(MyApp.UserView, \"View\")\n  \"user\"", 
-            "kind": "function", 
-            "longname": "InchTest.CodeExamples.single_code_example", 
-            "memberof": "InchTest.CodeExamples", 
+            "comment": "/**\n*\n* This function takes no arguments.\n*\n* Examples:\n*\n*   > InchTest.Naming.resource_name(MyApp.User)\n*   \"user\"\n*   > InchTest.Naming.resource_name(MyApp.UserView, \"View\")\n*   \"user\"\n*/",
+            "description": "This function takes no arguments.\n\nExamples:\n\n  > InchTest.Naming.resource_name(MyApp.User)\n  \"user\"\n  > InchTest.Naming.resource_name(MyApp.UserView, \"View\")\n  \"user\"",
+            "kind": "function",
+            "longname": "InchTest.CodeExamples.single_code_example",
+            "memberof": "InchTest.CodeExamples",
             "meta": {
                 "code": {
-                    "id": "astnode100000088", 
-                    "name": "single_code_example", 
-                    "type": "FunctionExpression", 
+                    "id": "astnode100000088",
+                    "name": "single_code_example",
+                    "type": "FunctionExpression",
                     "value": "function"
-                }, 
-                "filename": "inch_test.js", 
-                "lineno": 74, 
-                "path": "/src", 
+                },
+                "filename": "inch_test.js",
+                "lineno": 74,
+                "path": "/src",
                 "range": [
-                    1609, 
+                    1609,
                     1665
                 ]
-            }, 
-            "name": "single_code_example", 
+            },
+            "name": "single_code_example",
             "scope": "static"
-        }, 
+        },
         {
-            "comment": "/**\n*\n* This function takes no arguments.\n*\n* Examples:\n*\n*   > InchTest.Naming.resource_name(MyApp.User)\n*   \"user\"\n*   > InchTest.Naming.resource_name(MyApp.UserView, \"View\")\n*   \"user\"\n*\n* In general, `underscore` can be thought of as the reverse ...\n*\n*   > InchTest.Naming.resource_name(MyApp.User)\n*   \"user\"\n*   > InchTest.Naming.resource_name(MyApp.UserView, \"View\")\n*   \"user\"\n*/", 
-            "description": "This function takes no arguments.\n\nExamples:\n\n  > InchTest.Naming.resource_name(MyApp.User)\n  \"user\"\n  > InchTest.Naming.resource_name(MyApp.UserView, \"View\")\n  \"user\"\n\nIn general, `underscore` can be thought of as the reverse ...\n\n  > InchTest.Naming.resource_name(MyApp.User)\n  \"user\"\n  > InchTest.Naming.resource_name(MyApp.UserView, \"View\")\n  \"user\"", 
-            "kind": "function", 
-            "longname": "InchTest.CodeExamples.multiple_code_examples", 
-            "memberof": "InchTest.CodeExamples", 
+            "comment": "/**\n*\n* This function takes no arguments.\n*\n* Examples:\n*\n*   > InchTest.Naming.resource_name(MyApp.User)\n*   \"user\"\n*   > InchTest.Naming.resource_name(MyApp.UserView, \"View\")\n*   \"user\"\n*\n* In general, `underscore` can be thought of as the reverse ...\n*\n*   > InchTest.Naming.resource_name(MyApp.User)\n*   \"user\"\n*   > InchTest.Naming.resource_name(MyApp.UserView, \"View\")\n*   \"user\"\n*/",
+            "description": "This function takes no arguments.\n\nExamples:\n\n  > InchTest.Naming.resource_name(MyApp.User)\n  \"user\"\n  > InchTest.Naming.resource_name(MyApp.UserView, \"View\")\n  \"user\"\n\nIn general, `underscore` can be thought of as the reverse ...\n\n  > InchTest.Naming.resource_name(MyApp.User)\n  \"user\"\n  > InchTest.Naming.resource_name(MyApp.UserView, \"View\")\n  \"user\"",
+            "kind": "function",
+            "longname": "InchTest.CodeExamples.multiple_code_examples",
+            "memberof": "InchTest.CodeExamples",
             "meta": {
                 "code": {
-                    "id": "astnode100000093", 
-                    "name": "multiple_code_examples", 
-                    "type": "FunctionExpression", 
+                    "id": "astnode100000093",
+                    "name": "multiple_code_examples",
+                    "type": "FunctionExpression",
                     "value": "function"
-                }, 
-                "filename": "inch_test.js", 
-                "lineno": 95, 
-                "path": "/src", 
+                },
+                "filename": "inch_test.js",
+                "lineno": 95,
+                "path": "/src",
                 "range": [
-                    2094, 
+                    2094,
                     2153
                 ]
-            }, 
-            "name": "multiple_code_examples", 
+            },
+            "name": "multiple_code_examples",
             "scope": "static"
-        }, 
+        },
         {
             "files": [
                 "/home/rf/devel/Hello-World-NodeJS/src/inch_test.js"
-            ], 
-            "kind": "package", 
+            ],
+            "kind": "package",
             "longname": "package:undefined"
         }
     ]

data/test/fixtures/ruby/simple/lib/directives.rb

@@ -6,3 +6,24 @@ class Attributes
   # @return [String] Username (from Devise)
   attr_accessor :username
 end
+
+
+# Representation of attributes of a user in the database
+#
+class AttributesAccessor
+  attr_accessor :username
+  # @!attribute email
+  #   @return [String] E-mail address (from Devise)
+  attr_accessor :email
+end
+
+
+# Representation of attributes of a user in the database
+#
+class AttributesStruct < Struct.new(:email, :username)
+  # @!attribute email
+  #   @return [String] E-mail address (from Devise)
+  # @!attribute username
+  #   @return [String] Username (from Devise)
+end
+

data/test/unit/language/{nodejs → javascript}/code_object/function_object_test.rb

@@ -2,7 +2,7 @@ require File.expand_path(File.dirname(__FILE__) + '/../../../../test_helper')
 
 describe ::Inch::Language::Elixir::CodeObject::FunctionObject do
   before do
-    @codebase = fresh_codebase(:nodejs, :inch_test, 'all.json')
+    @codebase = fresh_codebase(:javascript, :inch_test, 'all.json')
     @objects = @codebase.objects
   end
 

data/test/unit/language/{nodejs → javascript}/provider/jsdoc/docstring_test.rb

@@ -1,7 +1,7 @@
 require File.expand_path(File.dirname(__FILE__) + '/../../../../../test_helper')
 
-describe ::Inch::Language::Nodejs::Provider::JSDoc::Docstring do
-  let(:described_class) { ::Inch::Language::Nodejs::Provider::JSDoc::Docstring }
+describe ::Inch::Language::JavaScript::Provider::JSDoc::Docstring do
+  let(:described_class) { ::Inch::Language::JavaScript::Provider::JSDoc::Docstring }
 
   #
   # JSDoc compatibility

data/test/unit/language/ruby/code_object/method_object_test.rb

@@ -292,19 +292,48 @@ describe ::Inch::Language::Ruby::CodeObject::MethodObject do
   end
 
   describe 'YARDs @!attribute directive on a class' do
-    #
-    it 'should work as a reader' do
-      m = @objects.find('Attributes#email')
-      refute_equal 0, m.score
-      refute m.undocumented?
+    describe "implemented as virtual attribute" do
+      it 'should work as a reader' do
+        m = @objects.find('Attributes#email')
+        refute_equal 0, m.score
+        refute m.undocumented?
+      end
+
+      it 'should work as a writer' do
+        m = @objects.find('Attributes#email=')
+        refute_equal 0, m.score
+        # refute m.undocumented?
+        # NOTE: this is undocumented since there is no original_docstring
+      end
     end
 
-    it 'should work as a writer' do
-      m = @objects.find('Attributes#email=')
-      refute_equal 0, m.score
-      # refute m.undocumented?
-      # NOTE: this is undocumented since there is no original_docstring
+    describe "used inside the class right before accessor macro" do
+      it 'should work as a reader' do
+        m = @objects.find('AttributesAccessor#email')
+        refute_equal 0, m.score
+        refute m.undocumented?
+      end
+
+      it 'should work as a writer' do
+        m = @objects.find('AttributesAccessor#email=')
+        refute_equal 0, m.score
+      end
+    end
+
+
+    describe "used inside a struct" do
+      it 'should work as a reader' do
+        m = @objects.find('AttributesStruct#email')
+        refute_equal 0, m.score
+        refute m.undocumented?
+      end
+
+      it 'should work as a writer' do
+        m = @objects.find('AttributesStruct#email=')
+        refute_equal 0, m.score
+      end
     end
+
   end
 
   describe 'YARDs @overload tag on methods' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inch
 version: !ruby/object:Gem::Version
-  version: 0.5.10
+  version: 0.6.0.rc1
 platform: ruby
 authors:
 - René Föhring
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-12 00:00:00.000000000 Z
+date: 2015-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -133,7 +133,7 @@ files:
 - config/.inch.yml.sample
 - config/base.rb
 - config/elixir.rb
-- config/nodejs.rb
+- config/javascript.rb
 - config/ruby.rb
 - inch.gemspec
 - lib/inch.rb
@@ -234,34 +234,34 @@ files:
 - lib/inch/language/elixir/roles/module.rb
 - lib/inch/language/elixir/roles/object.rb
 - lib/inch/language/elixir/roles/type.rb
-- lib/inch/language/nodejs/code_object/base.rb
-- lib/inch/language/nodejs/code_object/class_object.rb
-- lib/inch/language/nodejs/code_object/function_object.rb
-- lib/inch/language/nodejs/code_object/function_parameter_object.rb
-- lib/inch/language/nodejs/code_object/member_object.rb
-- lib/inch/language/nodejs/code_object/module_object.rb
-- lib/inch/language/nodejs/evaluation/base.rb
-- lib/inch/language/nodejs/evaluation/class_object.rb
-- lib/inch/language/nodejs/evaluation/function_object.rb
-- lib/inch/language/nodejs/evaluation/member_object.rb
-- lib/inch/language/nodejs/evaluation/module_object.rb
-- lib/inch/language/nodejs/import.rb
-- lib/inch/language/nodejs/provider/jsdoc.rb
-- lib/inch/language/nodejs/provider/jsdoc/docstring.rb
-- lib/inch/language/nodejs/provider/jsdoc/object.rb
-- lib/inch/language/nodejs/provider/jsdoc/object/base.rb
-- lib/inch/language/nodejs/provider/jsdoc/object/class_object.rb
-- lib/inch/language/nodejs/provider/jsdoc/object/function_object.rb
-- lib/inch/language/nodejs/provider/jsdoc/object/function_parameter_object.rb
-- lib/inch/language/nodejs/provider/jsdoc/object/member_object.rb
-- lib/inch/language/nodejs/provider/jsdoc/object/module_object.rb
-- lib/inch/language/nodejs/provider/jsdoc/parser.rb
-- lib/inch/language/nodejs/roles/base.rb
-- lib/inch/language/nodejs/roles/function.rb
-- lib/inch/language/nodejs/roles/function_parameter.rb
-- lib/inch/language/nodejs/roles/member.rb
-- lib/inch/language/nodejs/roles/module.rb
-- lib/inch/language/nodejs/roles/object.rb
+- lib/inch/language/javascript/code_object/base.rb
+- lib/inch/language/javascript/code_object/class_object.rb
+- lib/inch/language/javascript/code_object/function_object.rb
+- lib/inch/language/javascript/code_object/function_parameter_object.rb
+- lib/inch/language/javascript/code_object/member_object.rb
+- lib/inch/language/javascript/code_object/module_object.rb
+- lib/inch/language/javascript/evaluation/base.rb
+- lib/inch/language/javascript/evaluation/class_object.rb
+- lib/inch/language/javascript/evaluation/function_object.rb
+- lib/inch/language/javascript/evaluation/member_object.rb
+- lib/inch/language/javascript/evaluation/module_object.rb
+- lib/inch/language/javascript/import.rb
+- lib/inch/language/javascript/provider/jsdoc.rb
+- lib/inch/language/javascript/provider/jsdoc/docstring.rb
+- lib/inch/language/javascript/provider/jsdoc/object.rb
+- lib/inch/language/javascript/provider/jsdoc/object/base.rb
+- lib/inch/language/javascript/provider/jsdoc/object/class_object.rb
+- lib/inch/language/javascript/provider/jsdoc/object/function_object.rb
+- lib/inch/language/javascript/provider/jsdoc/object/function_parameter_object.rb
+- lib/inch/language/javascript/provider/jsdoc/object/member_object.rb
+- lib/inch/language/javascript/provider/jsdoc/object/module_object.rb
+- lib/inch/language/javascript/provider/jsdoc/parser.rb
+- lib/inch/language/javascript/roles/base.rb
+- lib/inch/language/javascript/roles/function.rb
+- lib/inch/language/javascript/roles/function_parameter.rb
+- lib/inch/language/javascript/roles/member.rb
+- lib/inch/language/javascript/roles/module.rb
+- lib/inch/language/javascript/roles/object.rb
 - lib/inch/language/ruby/code_object/base.rb
 - lib/inch/language/ruby/code_object/class_object.rb
 - lib/inch/language/ruby/code_object/class_variable_object.rb
@@ -311,7 +311,7 @@ files:
 - lib/inch/utils/weighted_list.rb
 - lib/inch/version.rb
 - test/fixtures/elixir/inch_test/all.json
-- test/fixtures/nodejs/inch_test/all.json
+- test/fixtures/javascript/inch_test/all.json
 - test/fixtures/ruby/alias_cycle/lib/alias.rb
 - test/fixtures/ruby/code_examples/lib/foo.rb
 - test/fixtures/ruby/diff1/lib/diff1.rb
@@ -370,8 +370,8 @@ files:
 - test/unit/evaluation/role_test.rb
 - test/unit/language/elixir/code_object/function_object_test.rb
 - test/unit/language/elixir/code_object/module_object_test.rb
-- test/unit/language/nodejs/code_object/function_object_test.rb
-- test/unit/language/nodejs/provider/jsdoc/docstring_test.rb
+- test/unit/language/javascript/code_object/function_object_test.rb
+- test/unit/language/javascript/provider/jsdoc/docstring_test.rb
 - test/unit/language/ruby/code_object/alias_test.rb
 - test/unit/language/ruby/code_object/method_object_test.rb
 - test/unit/language/ruby/provider/yard/docstring_test.rb
@@ -396,9 +396,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.2
@@ -407,7 +407,7 @@ specification_version: 4
 summary: Documentation measurement tool for Ruby
 test_files:
 - test/fixtures/elixir/inch_test/all.json
-- test/fixtures/nodejs/inch_test/all.json
+- test/fixtures/javascript/inch_test/all.json
 - test/fixtures/ruby/alias_cycle/lib/alias.rb
 - test/fixtures/ruby/code_examples/lib/foo.rb
 - test/fixtures/ruby/diff1/lib/diff1.rb
@@ -466,8 +466,8 @@ test_files:
 - test/unit/evaluation/role_test.rb
 - test/unit/language/elixir/code_object/function_object_test.rb
 - test/unit/language/elixir/code_object/module_object_test.rb
-- test/unit/language/nodejs/code_object/function_object_test.rb
-- test/unit/language/nodejs/provider/jsdoc/docstring_test.rb
+- test/unit/language/javascript/code_object/function_object_test.rb
+- test/unit/language/javascript/provider/jsdoc/docstring_test.rb
 - test/unit/language/ruby/code_object/alias_test.rb
 - test/unit/language/ruby/code_object/method_object_test.rb
 - test/unit/language/ruby/provider/yard/docstring_test.rb

data/lib/inch/language/nodejs/import.rb

@@ -1,27 +0,0 @@
-module Inch
-  module Language
-    module Nodejs
-    end
-  end
-end
-
-require 'inch/language/nodejs/provider/jsdoc'
-
-require 'inch/language/nodejs/code_object/base'
-require 'inch/language/nodejs/code_object/module_object'
-require 'inch/language/nodejs/code_object/class_object'
-require 'inch/language/nodejs/code_object/function_object'
-require 'inch/language/nodejs/code_object/member_object'
-
-require 'inch/language/nodejs/evaluation/base'
-require 'inch/language/nodejs/evaluation/module_object'
-require 'inch/language/nodejs/evaluation/class_object'
-require 'inch/language/nodejs/evaluation/function_object'
-require 'inch/language/nodejs/evaluation/member_object'
-
-require 'inch/language/nodejs/roles/base'
-require 'inch/language/nodejs/roles/object'
-require 'inch/language/nodejs/roles/module'
-require 'inch/language/nodejs/roles/function'
-require 'inch/language/nodejs/roles/function_parameter'
-require 'inch/language/nodejs/roles/member'