rubyfca 0.2.11 → 0.3.0

data/README.md

@@ -0,0 +1,129 @@
+# 💭 RubyFCA
+
+Command line tool for Formal Concept Analysis (FCA) written in Ruby.
+
+<kbd>
+    <img src="./samples/fca-source-result.png" width="800px"/>
+</kbd>
+
+
+## Change Log
+
+- Microsoft Excel `.xlsx` files supported [June 18, 2023]
+- Sample files added [June 18, 2023]
+
+## Features
+
+* Converts data in XLSX (Microsoft Excel), CSV (comma-separated values), or CXT ([Conexp](https://github.com/fcatools) and generate a Graphviz DOT file, a SVG/EPS vector image file, or /a PNG/JPG bitmap file.
+* Adopts the Ganter algorithm (with reference to its Perl implementation of [Fcastone](https://upriss.github.io/fcastone) by Uta Priss).
+
+## Dependencies
+
+- [Graphviz](https://graphviz.org/)
+
+For example, to install Graphviz using Homebrew on MacOS, execute the following command 
+
+    brew install graphviz
+
+## Installation
+
+Install the gem:
+
+    gem install rubyfca
+
+## How to Use
+
+    RubuFCA converts Conexp CXT data to Graphviz dot format.
+    
+    Usage:
+           rubyfca [options] <source file> <output file>
+    
+    where:
+    <source file>
+           ".xlsx", ".csv" ,".cxt"
+    <output file>
+           ."svg", ".png", ".jpg", ".eps", or ".dot"
+    [options]:
+              --full, -f:   Do not contract concept labels
+      --coloring, -c <i>:   Color concept nodes [0 = none (default), 1 =
+                            lightblue/pink, 2 = monochrome] (default: 0)
+          --straight, -s:   Straighten edges (available when output format is
+                            either png, jpg, svg, pdf, or eps)
+       --nodesep, -n <f>:   Size of separation between sister nodes (from 0.1 to
+                            5.0) (default: 0.4)
+       --ranksep, -r <f>:   Size of separation between ranks (from 0.1 to 5.0)
+                            (default: 0.2)
+            --legend, -l:   Print the legend of concept nodes (available only when
+                            using circle node shape)
+            --circle, -i:   Use circle shaped concept nodes
+           --version, -v:   Print version and exit
+              --help, -h:   Show this message
+
+## Examples
+
+### Input Data
+
+#### XLSX (Excel)
+
+<kbd>
+    <img src="./samples/xlsx-sample.png" width="800px"/>
+</kbd>
+
+#### CSV
+
+```
+        , Ostrich , Sparrow , Eagle , Lion , Bonobo , Human being
+bird    , X       , X       , X     ,      ,        ,  
+mammal  ,         ,         ,       , X    , X      , X
+ape     ,         ,         ,       ,      , X      , X
+flying  ,         , X       , X     ,      ,        ,  
+preying ,         ,         , X     , X    ,        ,  
+talking ,         ,         ,       ,      ,        , X
+```
+
+#### CXT
+
+```
+B
+
+6
+6
+
+Ostrich
+Sparrow
+Eagle
+Lion
+Bonobo
+Human being
+bird
+mammal
+ape
+flying
+preying
+talking
+XXX...
+...XXX
+....XX
+.XX...
+..XX..
+.....X
+```
+
+## Output
+
+`rubyfca input_file output_file --coloring 1 --full --nodesep 0.8 --ranksep 0.3 --straight`
+
+<img src="./samples/sample_01.svg" width="500px"/>
+
+
+`rubyfca input_file output_file --coloring 2 --nodesep 0.5 --ranksep 0.3`
+
+<img src="./samples/sample_02.svg" width="400px"/>
+
+`rubyfca input_file output_file --circle --legend --coloring 1 --full --nodesep 0.8 --ranksep 0.3 --straight`
+
+<img src="./samples/sample_03.svg" width="800px"/>
+
+## Copyright
+
+Copyright (c) 2009-2023 Yoichiro Hasebe and Kow Kuroda. See LICENSE for details.

data/Rakefile

@@ -1,2 +1,13 @@
 #!/usr/bin/env rake
+
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/bin/rubyfca

@@ -1,86 +1,92 @@
 #!/usr/bin/env ruby
-# -*- coding: utf-8 -*-
 
-$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
-require 'rubyfca'
+# frozen_string_literal: true
+
+Encoding.default_external = "UTF-8"
+
+require_relative "../lib/rubyfca"
 
 ################ parse options ##########
 
-opts = Trollop::options do
+opts = Optimist.options do
   version RubyFCA::VERSION
-  banner <<-EOS
-  
-RubuFCA converts Conexp CXT data to Graphviz dot format.
-
-Usage:
-       rubyfca [options] <source file> <output file>
-
-where:
-<source file>
-       ".cxt", ".csv"
-<output file>
-       ."dot", ".png", ".jpg", or ".eps"
-[options]:
-EOS
-
-  opt :full, "Do not contract concept labels", :default=> false
-  opt :coloring, "Color concept nodes [0 = none (default), 1 = lightblue/pink, 2 = monochrome]", :default => 0
-  opt :straight, "Straighten edges (available when output format is either png, jpg, svg, pdf, or eps)", :default => false
-  opt :nodesep, "Size of separation between sister nodes (from 0.1 to 5.0)", :default => 0.4
-  opt :ranksep, "Size of separation between ranks (from 0.1 to 5.0)", :default => 0.2
-  opt :legend, "Print the legend of concept nodes (available only when using circle node shape)", :default => false
-  opt :circle,  "Use circle shaped concept nodes", :default=> false
+  banner <<~USAGE
+    RubuFCA converts Conexp CXT data to Graphviz dot format.
 
-end
-Trollop::die :coloring, "must be 0, 1, or 2" if (opts[:coloring] > 2 || opts[:coloring] < 0)
-Trollop::die :ranksep,  "must be within 0.1 - 5.0" if (opts[:ranksep] < 0.1 || opts[:ranksep] > 5.0)
-Trollop::die :nodesep,  "must be within 0.1 - 5.0" if (opts[:nodesep] < 0.1 || opts[:nodesep] > 5.0)
-############### main program ############### 
+    Usage:
+           rubyfca [options] <source file> <output file>
 
-if ARGV.size != 2
-  showerror("Input and output files are not set properly", 1) 
+    where:
+    <source file>
+           ".xlsx", ".csv", ".cxt"
+    <output file>
+           ".svg", ".png", ".jpg", ".eps", or ."dot"
+    [options]:
+  USAGE
+
+  opt :full, "Do not contract concept labels", default: false
+  opt :coloring, "Color concept nodes [0 = none (default), 1 = lightblue/pink, 2 = monochrome]", default: 0
+  opt :straight, "Straighten edges (available when output format is either png, jpg, svg, pdf, or eps)", default: false
+  opt :nodesep, "Size of separation between sister nodes (from 0.1 to 5.0)", default: 0.4
+  opt :ranksep, "Size of separation between ranks (from 0.1 to 5.0)", default: 0.2
+  opt :legend, "Print the legend of concept nodes (available only when using circle node shape)", default: false
+  opt :circle, "Use circle shaped concept nodes", default: false
 end
 
-filename1 = ARGV[0]  #input  filename
-filename2 = ARGV[1]  #output filename
+Trollop.die :coloring, "must be 0, 1, or 2" if opts[:coloring] > 2 || opts[:coloring].negative?
+Trollop.die :ranksep,  "must be within 0.1 - 5.0" if opts[:ranksep] < 0.1 || opts[:ranksep] > 5.0
+Trollop.die :nodesep,  "must be within 0.1 - 5.0" if opts[:nodesep] < 0.1 || opts[:nodesep] > 5.0
+
+############### main program ###############
+
+ARGV.size != 2 && showerror("Input and output files are not set properly", 1)
+
+filename1 = ARGV[0]  # input filename
+filename2 = ARGV[1]  # output filename
 
 #
 # extract input and output file types
 #
-input_type  = filename1.slice(/\.[^\.]+\z/).split(//)[1..-1].join("")
-output_type = filename2.slice(/\.[^\.]+\z/).split(//)[1..-1].join("")
+input_type  = filename1.slice(/\.[^.]+\z/).split(//)[1..].join("")
+output_type = filename2.slice(/\.[^.]+\z/).split(//)[1..].join("")
 
-if (input_type !~ /\A(cxt|csv)\z/ || output_type !~ /\A(dot|png|jpg|svg|pdf|eps)\z/)
+if (input_type !~ /\A(cxt|csv|xlsx)\z/ ||
+    output_type !~ /\A(dot|png|jpg|svg|pdf|eps)\z/)
   showerror("These file extensions are not (yet) supported.", 1)
 end
 
 #
-# input data is kept as plain text
+# input data is kept as plain text unless file type is "xlsx"
 #
-f = File.open(filename1, "r")
-inputdata = f.read
-f.close
+
+if input_type == "xlsx"
+  inputdata = filename1
+else
+  f = File.open(filename1, "r:UTF-8:UTF-8")
+  inputdata = f.read
+  inputdata.gsub!(/\r\n?/) { "\n" }
+  f.close
+end
 
 #
 # ask for confirmation of overwriting an exisiting file
 #
-if (File.exist?(filename2) && !opts[:sil])
+if File.exist?(filename2) && !opts[:sil]
   print "#{filename2} exists and will be overwritten, OK? [y/n]"
-  var1 = STDIN.gets;
-  if /y/i !~ var1
-    exit;
-  end
+  var1 = $stdin.gets
+  exit if /y/i !~ var1
 end
 
 #
 # context data is converted to a hash table
 #
 begin
-  ctxt = FormalContext.new(inputdata, input_type, !opts[:full])
+  ctxt = FormalContext.new(inputdata, input_type, label_contraction: !opts[:full])
   ctxt.calcurate
-# rescue => e
-#   puts e
-#   showerror("Source data may have problems. Process aborted.", 1)
+rescue StandardError => e
+  pp e.message
+  pp e.backtrace
+  showerror("Source data may have problems. Process aborted.", 1)
 end
 
 #
@@ -88,8 +94,8 @@ end
 #
 case output_type
 when "dot"
-  File.open(filename2, "w") do |f|
-    f.write(ctxt.generate_dot(opts))
+  File.open(filename2, "w") do |file|
+    file.write(ctxt.generate_dot(opts))
   end
 when "png"
   ctxt.generate_img(filename2, "png", opts)

data/lib/rubyfca/ruby_graphviz.rb

@@ -1,5 +1,4 @@
-#!/usr/bin/env ruby
-# -*- coding: utf-8 -*-
+# frozen_string_literal: true
 
 ## lib/ruby_graphviz.rb -- graphviz dot generator library
 ## Author::    Yoichiro Hasebe (mailto: yohasebe@gmail.com)
@@ -7,8 +6,7 @@
 ## License::   GNU GPL version 3
 
 class RubyGraphviz
-  
-  ## Example: 
+  ## Example:
   ##
   ##   g = RubyGraphviz.new("newgraph", {:rankdir => "LR", :nodesep => "0.4", :ranksep => "0.2"})
   ##
@@ -17,7 +15,7 @@ class RubyGraphviz
     @graph_data = graph_hash
     @nodes = []
     @edges = []
-    @dot   = ""
+    @dot   = +""
     create_graph
   end
 
@@ -36,31 +34,31 @@ class RubyGraphviz
       end
       @dot << "]"
     end
-    @dot << ";\n"    
+    @dot << ";\n"
   end
-  
+
   def finish_graph
     @dot << "}\n"
   end
 
   def create_edge(edgetype, nid1, nid2, edge_hash = nil)
-    temp = "  #{nid1.to_s} #{edgetype} #{nid2.to_s}"
+    temp = "  #{nid1} #{edgetype} #{nid2}"
     index = 0
     if edge_hash
-      temp << " ["      
+      temp << " ["
       edge_hash.each do |k, v|
         k = k.to_s
         temp << "#{k} = \"#{v}\""
         index += 1
         temp << ", " unless index == edge_hash.size
       end
-      temp << "]"      
+      temp << "]"
     end
-    return temp
+    temp
   end
-  
+
   public
-  
+
   ## Add a subgraph to a graph (recursively)
   ##
   ## Example:
@@ -70,7 +68,7 @@ class RubyGraphviz
   def subgraph(graph)
     @dot << graph.to_dot.sub(/\Agraph/, "subgraph")
   end
-  
+
   ## Set default options for nodes
   ##
   ## Example:
@@ -108,7 +106,7 @@ class RubyGraphviz
     @dot << "];\n"
     self
   end
-  
+
   ## Create a node with its options
   ##
   ## Example:
@@ -116,7 +114,7 @@ class RubyGraphviz
   ##   graph.node("node-01", :label => "Node 01", :fillcolor => "pink")
   ##
   def node(node_id, node_hash = nil)
-    @dot << "  #{node_id.to_s}"
+    @dot << "  #{node_id}"
     index = 0
     if node_hash
       @dot << " ["
@@ -132,22 +130,22 @@ class RubyGraphviz
     self
   end
 
-  ## Create a non-directional edge (connection line between nodes) with its options 
+  ## Create a non-directional edge (connection line between nodes) with its options
   ##
   ## Example:
   ##
   ##   graph.edge("node-01", "node-02", :label => "connecting 1 and 2", :color => "lightblue")
-  ## 
+  ##
   def edge(nid1, nid2, edge_hash = nil)
     @dot << create_edge("--", nid1, nid2, edge_hash) + ";\n"
     self
   end
 
-  ## Create a directional edge (arrow from node to node) with its options 
+  ## Create a directional edge (arrow from node to node) with its options
   ##
   ## Example:
   ##   graph.arrow_edge("node-01", "node-02", :label => "from 1 to 2", :color => "lightblue")
-  ##  
+  ##
   def arrow_edge(nid1, nid2, edge_hash = nil)
     @dot << create_edge("->", nid1, nid2, edge_hash) + ";\n"
     self
@@ -159,12 +157,11 @@ class RubyGraphviz
     @dot << "{rank=same " + create_edge("--", nid1, nid2, edge_hash) + "}\n"
     self
   end
-  
+
   ## Convert graph into dot formatted data
   ##
   def to_dot
     finish_graph
-    @dot = @dot.gsub(/\"\</m, "<").gsub(/\>\"/m, ">")
-    return @dot
+    @dot.gsub(/"</m, "<").gsub(/>"/m, ">")
   end
 end

data/lib/rubyfca/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RubyFCA
-  VERSION = "0.2.11"
+  VERSION = "0.3.0"
 end