ruby-zen 0.0.3 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94b6c9e0213a4afbb888a4b4b937d8d1c1c3f7ede4719ce582a362762754e4f5
-  data.tar.gz: 04b4529731f7efc69027b1f71ee1f6e05e1684e9a0cf31ba1551c0ec6cd537ae
+  metadata.gz: d44ba9994cd4ecf369c78076589571a847a39f1ce30ea1c1c513beca3772d518
+  data.tar.gz: 661f144c3c950673420be799577979bddf13d30c34ea54a36fe5a876b5de143a
 SHA512:
-  metadata.gz: cd713a5cdb69fca117a7fa2011fc5e3f1d1be8ee6cd97e02b73f0213bf98ff93c65fac26eb7f81f6203be890463dd98c67daf87661b9872113e88b4189a0b697
-  data.tar.gz: e7a1006e8a688067e5c2d113e32bf3ebc63c35555319da1c64a3e479bf87dddead4a99fff0918da63e1d7ec009bac9ec3e302e22021392874c60b5f1300c86c3
+  metadata.gz: eda1558e53bf8228bfecc56b93eb54b1e7064f73af5f9eb34f66ca132e7939f7f9f72dfd8b0389634a1d4cfa910ef94f4b64c04fdad2730ff97519c162ca7541
+  data.tar.gz: dcc8fa003ee57d47e32bd278815250e70655abe9cdbed61a9dcb37b8530fc5304dd39d3b189b935dcd0af6e2f40d965f59aa653c7c186e2181e65e8de18a1d2f

data/README.md

@@ -1,27 +1,29 @@
 
 # RubyZen
 
-Display Ruby ZEN rules.
+Display Ruby ZEN rules in different languages.
+(By now only Spanish is available but it will change soon. Sorry!)
 
 ![logo](./docs/images/logo.png)
 
-# Documentation
+## Installation
 
-* Installation
-    1. Install Ruby on your system.
-    1. Install gem: `gem install ruby-zen`.
+1. Install Ruby on your system.
+1. Install gem: `gem install ruby-zen`.
 
-# Use
+## Use
 
-Run `rubyzen` command.
+Run `rubyzen` command on your terminal
 
 | Function | Description |
 | -------- | ------------------------- |
 | version  | Show currente version |
 | langs    | Show available languages |
 | show     | Show Ruby ZEN rules |
+| show --more | Show every rule with detailed explanation |
+| show --more --step | Show every rule with detailed explanation, step by step |
 
-# Contact
+## Contact
 
 * **Email**: `dvarrui@protonmail.com`
 * [IloveRuby - dvarrui](https://github.com/dvarrui/iloveruby)

data/lib/ruby-zen/application.rb

@@ -6,7 +6,6 @@ class Application
   include Params
 
   attr_reader :lang
-  attr_reader :config_filepath
   attr_reader :data
 
   def initialize(language = :es)
@@ -23,7 +22,6 @@ class Application
   def load_data
     basedir = File.dirname(__FILE__)
     filepath = File.join(basedir, 'files', ZEN_FILENAME)
-    @config_filepath = filepath
     YAML.load(File.read(filepath))
   end
 end

data/lib/ruby-zen/cli.rb

@@ -24,15 +24,14 @@ class CLI < Thor
   end
 
   map ['-s', '--show'] => 'show'
-  option :more, type: :boolean
   option :step, type: :boolean
+  option :full, type: :boolean
   option :lang, type: :string
-  desc 'show [LANG]', 'Display ZEN rules in the chosen language'
+  desc 'show [--step, --full, --lang=[LANG]]', 'Display ZEN rules in the chosen language'
   long_desc <<-LONGDESC
     Display the rules in the chosen language
   LONGDESC
   def show
-    # Typical error... write show(options) instead of show! jajaja
     RubyZen.show(options)
   end
 

data/lib/ruby-zen/files/man.txt

@@ -0,0 +1,360 @@
+
+NAME
+       ruby - Interpreted object-oriented scripting language
+
+DESCRIPTION
+       Ruby is an interpreted scripting language for quick and easy object-oriented programming.  It has many features
+       to process text files and to do system management tasks (like in Perl).  It is  simple,  straight-forward,  and
+       extensible.
+
+       If  you  want  a  language for easy object-oriented programming, or you don't like the Perl ugliness, or you do
+       like the concept of LISP, but don't like too many parentheses, Ruby might be your language of choice.
+
+FEATURES
+
+       Interpretive
+              Ruby is an interpreted language, so you don't have to recompile programs  written  in  Ruby  to  execute
+              them.
+
+       Variables have no type (dynamic typing)
+              Variables  in Ruby can contain data of any type.  You don't have to worry about variable typing.  Conse-
+              quently, it has a weaker compile time check.
+
+       No declaration needed
+              You can use variables in your Ruby programs without any declarations.  Variable names denote their scope
+              - global, class, instance, or local.
+
+       Simple syntax
+              Ruby has a simple syntax influenced slightly from Eiffel.
+
+       No user-level memory management
+              Ruby has automatic memory management.  Objects no longer referenced from anywhere are automatically col-
+              lected by the garbage collector built into the interpreter.
+
+       Everything is an object
+              Ruby is a purely object-oriented language, and was so since its creation.  Even such basic data as inte-
+              gers are seen as objects.
+
+       Class, inheritance, and methods
+              Being  an  object-oriented  language,  Ruby  naturally has basic features like classes, inheritance, and
+              methods.
+
+       Singleton methods
+              Ruby has the ability to define methods for certain objects.  For example, you can define a  press-button
+              action  for  certain widget by defining a singleton method for the button.  Or, you can make up your own
+              prototype based object system using singleton methods, if you want to.
+
+       Mix-in by modules
+              Ruby intentionally does not have the multiple inheritance as it is a source of confusion.  Instead, Ruby
+              has the ability to share implementations across the inheritance tree.  This is often called a `Mix-in'.
+
+       Iterators
+              Ruby has iterators for loop abstraction.
+
+       Closures
+              In Ruby, you can objectify the procedure.
+
+       Text processing and regular expressions
+              Ruby has a bunch of text processing features like in Perl.
+
+       M17N, character set independent
+              Ruby supports multilingualized programming. Easy to process texts written in many different natural lan-
+              guages and encoded in many different character encodings, without dependence on Unicode.
+
+       Bignums
+              With built-in bignums, you can for example calculate factorial(400).
+
+       Reflection and domain specific languages
+              Class is also an instance of the Class class. Definition of classes and methods is an expression just as
+              1+1  is.  So  your  programs can even write and modify programs.  Thus you can write your application in
+              your own programming language on top of Ruby.
+
+       Exception handling
+              As in Java(tm).
+
+       Direct access to the OS
+              Ruby can use most UNIX system calls, often used in system programming.
+
+       Dynamic loading
+              On most UNIX systems, you can load object files into the Ruby interpreter on-the-fly.
+
+       Rich libraries
+              In addition to the ``builtin libraries'' and ``standard libraries'' that are bundled with Ruby,  a  vast
+              amount  of  third-party  libraries  (``gems'')  are  available  via the package management system called
+              `RubyGems', namely the gem(1) command.  Visit RubyGems.org (https://rubygems.org/) to find the gems  you
+              need, and explore GitHub (https://github.com/) to see how they are being developed and used.
+
+
+       -c     Causes Ruby to check the syntax of the script and exit without executing. If there are no syntax errors,
+              Ruby will print ``Syntax OK'' to the standard output.
+
+       -d
+
+       --debug
+              Turns on debug mode.  "$DEBUG" will be set to true.
+
+       -e command
+              Specifies  script  from  command-line  while  telling Ruby not to search the rest of the arguments for a
+              script file name.
+
+       -h
+
+       --help Prints a summary of the options.
+
+       -i extension
+              Specifies in-place-edit mode.  The extension, if specified, is added to old file name to make  a  backup
+              copy.  For example:
+
+              % echo matz > /tmp/junk
+              % cat /tmp/junk
+              matz
+              % ruby -p -i.bak -e '$_.upcase!' /tmp/junk
+              % cat /tmp/junk
+              MATZ
+              % cat /tmp/junk.bak
+              matz
+
+       -l     (The  lowercase  letter  ``ell''.)  Enables automatic line-ending processing, which means to firstly set
+              "$\" to the value of "$/", and secondly chops every line read using chop!.
+
+       -n     Causes Ruby to assume the following loop around your script, which makes it iterate over file name argu-
+              ments somewhat like sed -n or awk.
+
+              while gets
+                ...
+              end
+
+       -p     Acts  mostly  same  as -n switch, but print the value of variable "$_" at the each end of the loop.  For
+              example:
+
+              % echo matz | ruby -p -e '$_.tr! "a-z", "A-Z"'
+              MATZ
+
+       -r library
+              Causes Ruby to load the library using require.  It is useful when using -n or -p.
+
+       -s     Enables some switch parsing for switches after script name but before any file name arguments (or before
+              a --).  Any switches found there are removed from ARGV and set the corresponding variable in the script.
+              For example:
+
+              #! /usr/local/bin/ruby -s
+              # prints "true" if invoked with `-xyz' switch.
+              print "true\n" if $xyz
+
+       -v     Enables verbose mode.  Ruby will print its version at the beginning and set the variable  "$VERBOSE"  to
+              true.   Some  methods  print  extra  messages if this variable is true.  If this switch is given, and no
+              other switches are present, Ruby quits after printing its version.
+
+       -w     Enables verbose mode without printing version message at the beginning.  It sets the "$VERBOSE" variable
+              to true.
+
+       -x[directory]
+              Tells  Ruby that the script is embedded in a message.  Leading garbage will be discarded until the first
+              line that starts with ``#!''  and contains the string, ``ruby''.  Any meaningful switches on  that  line
+              will  be  applied.   The  end  of the script must be specified with either EOF, "^D" ("control-D"), "^Z"
+              ("control-Z"), or the reserved word __END__.  If the directory name is specified, Ruby  will  switch  to
+              that directory before executing script.
+
+       -y
+
+       --yydebug
+              DO NOT USE.
+
+              Turns  on  compiler  debug mode.  Ruby will print a bunch of internal state messages during compilation.
+              Only specify this switch you are going to debug the Ruby interpreter.
+
+       --disable-FEATURE
+
+       --enable-FEATURE
+              Disables (or enables) the specified FEATURE.
+
+       --disable-gems
+
+       --enable-gems
+              Disables (or enables) RubyGems libraries.  By default,  Ruby  will  load  the  latest  version  of  each
+              installed gem. The Gem constant is true if RubyGems is enabled, false if otherwise.
+
+       --disable-rubyopt
+
+       --enable-rubyopt
+              Ignores (or considers) the RUBYOPT environment variable. By default, Ruby considers the variable.
+
+       --disable-all
+
+       --enable-all
+              Disables (or enables) all features.
+
+       --dump=target
+              Dump some informations.
+
+              Prints the specified target.  target can be one of;
+
+       version
+              version description same as --version
+
+       usage  brief usage message same as -h
+
+       help   Show long help message same as --help
+
+       syntax check of syntax same as -c --yydebug
+
+       yydebug
+              compiler debug mode, same as --yydebug
+
+              Only specify this switch if you are going to debug the Ruby interpreter.
+
+       parsetree
+
+       parsetree_with_comment
+              AST nodes tree
+
+              Only specify this switch if you are going to debug the Ruby interpreter.
+
+       insns  disassembled instructions
+
+              Only specify this switch if you are going to debug the Ruby interpreter.
+
+       --verbose
+              Enables verbose mode without printing version message at the beginning.  It sets the "$VERBOSE" variable
+              to true.  If this switch is given, and no other switches are present, Ruby quits after printing its ver-
+              sion.
+
+ENVIRONMENT
+       RUBYLIB
+              A  colon-separated  list  of  directories that are added to Ruby's library load path ("$:"). Directories
+              from this environment variable are searched before the standard load path is searched.
+
+              e.g.:
+                RUBYLIB="$HOME/lib/ruby:$HOME/lib/rubyext"
+
+       RUBYOPT
+              Additional Ruby options.
+
+              e.g.
+                RUBYOPT="-w -Ke"
+
+              Note that  RUBYOPT  can  contain  only  -d,-E,-I,-K,-r,-T,-U,-v,-w,-W,  --debug,  --disable-FEATURE  and
+              --enable-FEATURE.
+
+       RUBYPATH
+              A  colon-separated  list  of directories that Ruby searches for Ruby programs when the -S flag is speci-
+              fied.  This variable precedes the PATH environment variable.
+
+       RUBYSHELL
+              The path to the system shell command.  This environment variable is enabled for only  mswin32,  mingw32,
+              and OS/2 platforms.  If this variable is not defined, Ruby refers to COMSPEC.
+
+       PATH   Ruby refers to the PATH environment variable on calling Kernel#system.
+
+              And  Ruby  depends  on some RubyGems related environment variables unless RubyGems is disabled.  See the
+              help of gem(1) as below.
+
+              % gem help
+
+GC ENVIRONMENT
+       The Ruby garbage collector (GC) tracks objects in fixed-sized slots, but each object may have auxiliary  memory
+       allocations handled by the malloc family of C standard library calls ( malloc(3), calloc(3), and realloc(3)) In
+       this documentatation, the "heap" refers to the Ruby object heap of fixed-sized slots, while "malloc" refers  to
+       auxiliary allocations commonly referred to as the "process heap".  Thus there are at least two possible ways to
+       trigger GC:
+
+       1      Reaching the object limit.
+
+       2      Reaching the malloc limit.
+
+              In Ruby 2.1, the generational GC was introduced and the limits are divided into young  and  old  genera-
+              tions, providing two additional ways to trigger a GC:
+
+       3      Reaching the old object limit.
+
+       4      Reaching the old malloc limit.
+
+              There  are  currently  4  possible areas where the GC may be tuned by the following 11 environment vari-
+              ables:
+
+       RUBY_GC_HEAP_INIT_SLOTS
+              Initial allocation slots.  Introduced in Ruby 2.1, default: 10000.
+
+       RUBY_GC_HEAP_FREE_SLOTS
+              Prepare at least this amount of slots after GC.  Allocate this number slots  if  there  are  not  enough
+              slots.  Introduced in Ruby 2.1, default: 4096
+
+       RUBY_GC_HEAP_GROWTH_FACTOR
+              Increase  allocation  rate of heap slots by this factor.  Introduced in Ruby 2.1, default: 1.8, minimum:
+              1.0 (no growth)
+
+       RUBY_GC_HEAP_GROWTH_MAX_SLOTS
+              Allocation  rate  is  limited  to  this  number  of  slots,  preventing  excessive  allocation  due   to
+              RUBY_GC_HEAP_GROWTH_FACTOR.  Introduced in Ruby 2.1, default: 0 (no limit)
+
+       RUBY_GC_HEAP_OLDOBJECT_LIMIT_FACTOR
+              Perform a full GC when the number of old objects is more than R * N, where R is this factor and N is the
+              number of old objects after the last full GC.  Introduced in Ruby 2.1.1, default: 2.0
+
+       RUBY_GC_MALLOC_LIMIT
+              The initial limit of young generation allocation from the malloc-family.  GC will start when this  limit
+              is reached.  Default: 16MB
+
+       RUBY_GC_MALLOC_LIMIT_MAX
+              The  maximum limit of young generation allocation from malloc before GC starts.  Prevents excessive mal-
+              loc growth due to RUBY_GC_MALLOC_LIMIT_GROWTH_FACTOR.  Introduced in Ruby 2.1, default: 32MB.
+
+       RUBY_GC_MALLOC_LIMIT_GROWTH_FACTOR
+              Increases the limit of young generation malloc calls, reducing GC frequency but increasing malloc growth
+              until  RUBY_GC_MALLOC_LIMIT_MAX  is  reached.   Introduced  in  Ruby 2.1, default: 1.4, minimum: 1.0 (no
+              growth)
+
+       RUBY_GC_OLDMALLOC_LIMIT
+              The initial limit of old generation allocation from malloc, a full GC will  start  when  this  limit  is
+              reached.  Introduced in Ruby 2.1, default: 16MB
+
+       RUBY_GC_OLDMALLOC_LIMIT_MAX
+              The  maximum limit of old generation allocation from malloc before a full GC starts.  Prevents excessive
+              malloc growth due to RUBY_GC_OLDMALLOC_LIMIT_GROWTH_FACTOR.  Introduced in Ruby 2.1, default: 128MB
+
+       RUBY_GC_OLDMALLOC_LIMIT_GROWTH_FACTOR
+              Increases the limit of old generation malloc allocation, reducing full GC frequency but increasing  mal-
+              loc growth until RUBY_GC_OLDMALLOC_LIMIT_MAX is reached.  Introduced in Ruby 2.1, default: 1.2, minimum:
+              1.0 (no growth)
+
+STACK SIZE ENVIRONMENT
+       Stack size environment variables are implementation-dependent and subject to change with different versions  of
+       Ruby.   The  VM  stack is used for pure-Ruby code and managed by the virtual machine.  Machine stack is used by
+       the operating system and its usage is dependent on C extensions as well as C  compiler  options.   Using  lower
+       values  for  these  may  allow applications to keep more Fibers or Threads running; but increases the chance of
+       SystemStackError exceptions and segmentation faults (SIGSEGV).  These environment variables are available since
+       Ruby 2.0.0.  All values are specified in bytes.
+
+       RUBY_THREAD_VM_STACK_SIZE
+              VM stack size used at thread creation.  default: 131072 (32-bit CPU) or 262144 (64-bit)
+
+       RUBY_THREAD_MACHINE_STACK_SIZE
+              Machine stack size used at thread creation.  default: 524288 or 1048575
+
+       RUBY_FIBER_VM_STACK_SIZE
+              VM stack size used at fiber creation.  default: 65536 or 131072
+
+       RUBY_FIBER_MACHINE_STACK_SIZE
+              Machine stack size used at fiber creation.  default: 262144 or 524288
+
+SEE ALSO
+       https://www.ruby-lang.org/
+              The official web site.
+
+       https://www.ruby-toolbox.com/
+              Comprehensive catalog of Ruby libraries.
+
+REPORTING BUGS
+       ·      Security  vulnerabilities  should be reported via an email to Mt security@ruby-lang.org.  Reported prob-
+              lems will be published after being fixed.
+
+       ·      Other bugs and feature requests can be reported via the Ruby Issue Tracking  System  (https://bugs.ruby-
+              lang.org/).  Do not report security vulnerabilities via this system because it publishes the vulnerabil-
+              ities immediately.
+
+AUTHORS
+       Ruby is designed and implemented by Yukihiro Matsumoto <matz@netlab.jp>.
+
+       See <https://bugs.ruby-lang.org/projects/ruby/wiki/Contributors> for contributors to Ruby.
+
+October 31, 2015                           Ruby Programmer's Reference Guide                                   RUBY(1)

data/lib/ruby-zen/files/zenfile.yaml

@@ -1,4 +1,28 @@
 # encoding: UTF-8
+:en:
+- :rule: Emphasize human needs more than those of the machine.
+  :desc:
+    - Put the focus more on the programmer and less on the machine.
+    - Often people, especially computer engineers, focus on machines.
+    - They think, "By doing this, the machine will run faster. By doing this, the machine will run more efficiently. "Doing this..." They are machine-centric.
+    - We really need to focus on people, how they make programs or how they handle applications.
+    - We are the bosses. They are the slaves.
+- :rule: El principio de la menor sorpresa.
+  :desc:
+    - Language should behave in such a way as to minimize confusion among experienced users.
+    - Matz defined it this way in an interview. Everyone has a personal past.
+    - Someone may come from another language and may be surprised by different aspects of the language.
+    - Then they might say, 'I'm surprised by this feature of language, so Ruby violates the principle of least surprise.
+    - Wait, wait. The principle of least surprise is NOT just for you.
+    - The principle of least surprise means that Ruby's rules don't change. There are no exceptions.
+    - Once you know the rules. There are no surprises.
+- :rule: Matz ha dicho que su principal objetivo era hacer un lenguaje que le divirtiera
+  :desc:
+    - For fun we will minimize programming work and possible confusion.
+    - That is, rule 1 and rule 2 lead to fun.
+    - Fun brings joy.
+    - Joy gives happiness.
+    - The Ruby path leads us to happiness!
 :es:
 - :rule: Enfatizar las necesidades humanas más que de las de la máquina.
   :desc:
@@ -23,10 +47,3 @@
     - La diversión da alegría.
     - La alegría da felicidad.
     - El camino Ruby nos lleva a la felicidad!
-:en:
-- :rule: Enfatizar las necesidades humanas más que las de la máquina.
-  :desc: A menudo la gente, especialmente los ingenieros en computación, se centran en las máquinas. Ellos piensan, "Haciendo esto, la máquina funcionará más rápido. Haciendo esto, la máquina funcionará de manera más eficiente. Haciendo esto..." Están centrados en las máquinas, pero en realidad necesitamos centrarnos en las personas, en cómo hacen programas o cómo manejan las aplicaciones en los ordenadores. Nosotros somos los jefes. Ellos son los esclavos.
-- :rule: El principio de la menor sorpresa.
-  :desc: El lenguaje debe comportarse de tal manera que minimice la confusión de los usuarios experimentados.
-- :rule: Matz ha dicho que su principal objetivo era hacer un lenguaje que le divirtiera
-  :desc: Para divertirse vamos a minimizar el trabajo de programación y la posible confusión.

data/lib/ruby-zen/params.rb

@@ -1,8 +1,9 @@
 
 module Params
   NAME         = 'rubyzen'
-  VERSION      = '0.0.3'
+  VERSION      = '0.0.6'
   GEMNAME      = 'ruby-zen'
   LANGS        = [ :es, :en ]
   ZEN_FILENAME = 'zenfile.yaml'
+  HOMEPAGE     = 'https://github.com/dvarrui/tools/tree/main/ruby.zen.d'
 end

data/lib/ruby-zen/rules.rb

@@ -7,10 +7,13 @@ class Rules
     @app = application
   end
 
-  def show(options = { 'more' => false, 'step' => true })
-    if options['more']
-      step = options['step']
-      show_more(step: step)
+  def show(options = { 'full' => false, 'step' => true })
+    full = options['full']
+    step = options['step']
+
+    full = true if step
+    if full
+      show_full(step: step)
     else
       show_only_names
     end
@@ -26,7 +29,7 @@ class Rules
     puts
   end
 
-  def show_more(step:)
+  def show_full(step:)
     show_title
 
     @app.rules.each_with_index do |rule, index|

data/lib/ruby-zen.rb

@@ -15,7 +15,8 @@ class RubyZen
   end
 
   def self.show(options)
-    app = Application.new
+    lang = options['lang']&.to_sym || :en
+    app = Application.new(lang)
     Rules.new(app).show(options)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-zen
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.6
 platform: ruby
 authors:
 - David Vargas Ruiz
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-05 00:00:00.000000000 Z
+date: 2022-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -67,15 +67,16 @@ files:
 - lib/ruby-zen.rb
 - lib/ruby-zen/application.rb
 - lib/ruby-zen/cli.rb
+- lib/ruby-zen/files/man.txt
 - lib/ruby-zen/files/title.txt
 - lib/ruby-zen/files/zenfile.yaml
 - lib/ruby-zen/params.rb
 - lib/ruby-zen/rules.rb
-homepage: https://github.com/dvarrui/ruby-zen/tree/master
+homepage: https://github.com/dvarrui/tools/tree/main/ruby.zen.d
 licenses:
 - GPL-3.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -90,8 +91,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: Display Ruby ZEN rules
 test_files: []