Changes between Version 5 and Version 6 of howto

Timestamp:

Aug 31, 2020, 2:41:29 AM (4 years ago)

Author:

tothm

Comment:

--

howto

@@ -47 +47 @@
  * This mode helps !RefactorErl to find the include files in the appropriate include folders.
 
+= Using the tool
+!RefactorErl, as stated in its name, originally started as a refactoring project for Erlang. During the years of development, the focus of the project was shifted to the direction of code comprehension and software maintenance support. The main features of the tool are:
+ * Refactoring
+ * Semantic queries
+ * Dependency detection and visualisation 
+ * Software complexity metrics
+ * Bad smell detection
+ * Checking design rules
+ * Vulnerability detection
+ * Clustering
+ * Duplicated code detection
+ * etc 
 
+= Demo
 
-= Using the web interface
+In the next examples we will use the source of the Mnesaia database as a target software. 
+ * starting the tool: {{{bin/referl -db kcmini}}}
+ * building the database: 
+{{{
+Eshell V10.6.1  (abort with ^G)
+(refactorerl@localhost)1> ri:ls().
+{{ok,[]},{error,[]}}
+ok
+(refactorerl@localhost)2> ri:envs().
+output = original
+appbase = "/usr/local/Cellar/erlang/22.2.1/lib/erlang/lib"
+ok
+(refactorerl@localhost)3> ri:add(erlang, mnesia).
+Adding: /usr/local/Cellar/erlang/22.2.1/lib/erlang/lib/mnesia-4.16.2/src
+| 5.20 kB/s >>>>>>>>>>>>>>>>>>>| [ 420/ 420] mnesia.erl
+| 6.78 kB/s >>>>>>>>>>>>>>>>>>>| [   5/   5] mnesia_app.erl
+| 8.12 kB/s >>>>>>>>>>>>>>>>>>>| [   3/   3] mnesia_backend_type.erl
+| 5.13 kB/s >>>>>>>>>>>>>>>>>>>| [  12/  12] mnesia_backup.erl
+|>>>>>>>>>>>>         6.05 kB/s| [  48/  87] mnesia_bup.erl
+....
+(refactorerl@localhost)4> ri:ls().
+{{ok,["/usr/local/Cellar/erlang/22.2.1/lib/erlang/lib/mnesia-4.16.2/src/mnesia_app.erl",
+      "/usr/local/Cellar/erlang/22.2.1/lib/erlang/lib/mnesia-4.16.2/src/mnesia_controller.erl",
+      "/usr/local/Cellar/erlang/22.2.1/lib/erlang/lib/mnesia-4.16.2/src/mnesia_ext_sup.erl",
+      "/usr/local/Cellar/erlang/22.2.1/lib/erlang/lib/mnesia-4.16.2/src/mnesia_frag_hash.erl",
+....
+}}}
+
+{{{ri:ls()}}} checks the content of the database, so it lists the already analysed files. 
+{{{ri:envs()}}} checks the environmental variables of !RefactorErl. You might realise that the path of the Erlang installation library was already set, so we can use its subkey to add the mnesia application: {{{ri:add(erlang, mnesia).}}}
+
+The query {{{ri:q("mods.loc:sum").}}} returns the line of code analyzed:
+{{{
+(refactorerl@localhost)5> ri:q("mods.loc:sum").
+    sum = 24299
+}}}
 
 = Using the query language
 
-= Dependency analysis
+The semantic query language of !RefactorErl can be used to gather information about the source code according to the interest of the developer. 
 
-= Code duplicates
+The query language was designed according to the syntactic/semantic entities of the Erlang language. So it introduces files, macros, modules, functions, expressions, records, record fields, etc.
+
+The detailed description of the queries can be found [wiki:SemanticQuery here]. The description of the entities, its properties and selectors are defined [http://pnyf.inf.elte.hu/trac/refactorerl/wiki/SemanticQuery/Components here], but you can use the {{{?}}} selector in {{{ri}}}: {{{ri:q("mods.?")}}}. For further examples please check this [http://pnyf.inf.elte.hu/trac/refactorerl/wiki/SemanticQuery/Examples page].
+
+Once you build a query, you need an initial selector to start. That can be either a position based entity selection {{{@fun}}} -- the function pointed in the web interface, or a global starting point, like {{{mods}}} -- all analysed modules. 
+
+Once you selected an entity, you may ask some property of that entity:
+ * {{{mods.name}}} -- the name of the module
+or ask its connected entities:
+ * {{{mods.funs}}} -- functions defined in the modules
+
+You can also filter the entities:
+ * {{{mods[name=foo].funs.calls}}} -- what are the functions that are called in the functions of the foo module
+
+In the following, we will show some queries on the previously built database from the source of Mnesia.
+
+== Detecting relations, gathering information about the source code
+
+ * {{{ri:q(mods[name=mnesia_log].funs).}}} -- listing all the functions from the mnesia_log module
+ * {{{ri:q(mods[name=mnesia_log].funs.name).}}} -- listing the name of the functions from the mnesia_log module
+ * {{{ri:q(mods[name=mnesia_log].funs.refs).}}} -- listing the references (the function applications) of the the functions from the mnesia_log module
+ * {{{ri:q(mods[name=mnesia_log].funs[.refs]).}}}
+ * {{{mods[name=mnesia_log].funs[name=open_log]}}}
+ * {{{mods[name=mnesia_log].funs[name=open_log, arity=4]}}}
+ * {{{mods[name=mnesia_log].funs[name=open_log].refs}}}
+ * {{{mods[name=mnesia_log].funs[name=open_log].called_by}}}
+ * {{{@fun.called_by}}}
+ * {{{mods[name=mnesia_log].funs[name=open_log].calls}}}
+ * {{{@fun.calls}}}
+
+== Checking design rules
+
+== Detecting vulnerabilities
+
+==