sutty-cli 0.2.1 → 0.3.0rc

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb3fe159753323120692f2a9362297ad2d426c86c9157c201701c4ea1550f751
-  data.tar.gz: 15cc8ce51e749cecf5b5d3660c94849315a9701eae3e6aab52e2a1a066f37ae0
+  metadata.gz: a3f2c98ed854fd05ff7e75d5353b421ec3ec3195074be762e722eea2efdca1a7
+  data.tar.gz: e7b901948cddc1a7ced86caacb7d08ea9002f0cedaef9f3a0c10e76fab3fe981
 SHA512:
-  metadata.gz: dc9d1c193c52b4acca35a8ced028728d87f6146fbecc31be425922e057d0f4b1e40665409cab9a724cfe3c9fcb239095458ab2f274ee8ca3ece7f621d0ebf772
-  data.tar.gz: 6de2d1ab46cd4850bdd227a6c8820b603e5154438e6b117929211e37180d3e05fda67c2204be03331991533623e6fd3be38d2f334aab8bdfc4df97c2abd5a725
+  metadata.gz: 42ae5a382fefcdb2f3f19dbcd4b6865444913bdcc32d2511417739eb2ca0bce88a9da3d56471d00e33d032a4023b2244a7845d33a779a8e0ab3359aa09597021
+  data.tar.gz: 84c5bbf870b299878980e86fede20c43ed5e3351c4e6c63e997485771ed872e50c77375a8f95461d7c78970cb8663c4e0a980217de0329dfe8ccd6daed617825

data/lib/sutty/cli/cli.rb

@@ -4,6 +4,8 @@ require 'thor'
 require 'date'
 require_relative 'commands/layout'
 require_relative 'commands/field'
+require_relative 'i18n'
+require_relative '../schema'
 
 module Sutty
   module Cli
@@ -15,46 +17,45 @@ module Sutty
       # Error raised by this runner
       Error = Class.new(StandardError)
 
-      desc 'version', 'sutty-cli version'
+      desc I18n.t('version.desc.example'), I18n.t('version.desc.text')
       def version
         require_relative 'version'
         puts "v#{Sutty::Cli::VERSION}"
       end
       map %w(--version -v) => :version
 
-      desc 'post', 'Adds a post'
-      method_option :help, aliases: '-h', type: :boolean,
-                           desc: 'Display usage information'
+      desc I18n.t('post.desc.example'), I18n.t('post.desc.text')
+      method_option :help, aliases: '-h', type: :boolean, desc: I18n.t('help')
 
       method_option :layout,
                     aliases: '-l',
                     type: :string,
-                    desc: 'Layout',
+                    desc: I18n.t('post.flags.layout'),
                     required: true,
                     enum: Sutty::Cli::Commands::Layout.layouts
 
       method_option :title,
                     aliases: '-t',
                     type: :string,
-                    desc: 'Title'
+                    desc: I18n.t('post.flags.title')
 
       method_option :date,
                     aliases: '-d',
                     type: :string,
-                    desc: 'Date',
+                    desc: I18n.t('post.flags.date'),
                     default: Date.today.to_s
 
       # TODO: Bring locales from Jekyll configuration
       method_option :locale,
                     aliases: '-L',
                     type: :string,
-                    desc: 'Locale collection',
+                    desc: I18n.t('post.flags.locale'),
                     default: 'posts'
 
       method_option :content,
                     aliases: '-c',
                     type: :string,
-                    desc: 'Text length',
+                    desc: I18n.t('post.flags.content'),
                     default: 'short',
                     enum: %w[short long]
 
@@ -67,9 +68,8 @@ module Sutty
         end
       end
 
-      desc 'container NAME', 'Adds a container'
-      method_option :help, aliases: '-h', type: :boolean,
-                           desc: 'Display usage information'
+      desc I18n.t('container.desc.example'), I18n.t('container.desc.text')
+      method_option :help, aliases: '-h', type: :boolean, desc: I18n.t('help')
       def container(name)
         if options[:help]
           invoke :help, ['container']
@@ -79,59 +79,63 @@ module Sutty
         end
       end
 
-      desc 'field NAME', 'Adds a field with a type to a layout'
-      long_desc <<~EOD
-        A field is a data type with a name, from which Sutty can build a
-        form on the panel and use it to validate posts.
-
-        After you add a field, edit the layout file and add labels and
-        help description in different languages.
-      EOD
+      desc I18n.t('field.desc.example'), I18n.t('field.desc.text')
+      long_desc I18n.t('field.desc.long')
 
       method_option :help,
                     aliases: '-h',
                     type: :boolean,
-                    desc: 'Display usage information'
+                    desc: I18n.t('help')
+
+      method_option :before,
+                    type: :string,
+                    desc: I18n.t('field.flags.before'),
+                    default: 'order'
+
+      method_option :force,
+                    type: :boolean,
+                    desc: I18n.t('field.flags.force'),
+                    default: false
 
       method_option :layout,
                     aliases: '-l',
                     type: :string,
-                    desc: 'Layout to add',
+                    desc: I18n.t('field.flags.layout'),
                     required: true,
                     enum: Sutty::Cli::Commands::Layout.layouts
 
       method_option :type,
                     aliases: '-t',
                     type: :string,
-                    desc: 'Field type',
+                    desc: I18n.t('field.flags.type'),
                     required: true,
-                    enum: Sutty::Cli::Commands::Field.fields
+                    enum: Sutty::Schema.field_types.map(&:to_s)
 
       method_option :required,
                     aliases: '-r',
                     type: :boolean,
-                    desc: 'Field is required'
+                    desc: I18n.t('field.flags.required')
 
       method_option :private,
                     aliases: '-p',
                     type: :boolean,
-                    desc: 'Field is private (encrypted)'
+                    desc: I18n.t('field.flags.private')
 
       method_option :inverse,
                     aliases: '-i',
                     type: :string,
-                    desc: 'Inverse relation',
+                    desc: I18n.t('field.flags.inverse'),
                     required: Sutty::Cli::Commands::Field.inverse_required?
 
       method_option :filter,
                     aliases: '-F',
                     type: :string,
-                    desc: 'Filter relations by this field'
+                    desc: I18n.t('field.flags.filter')
 
       method_option :value,
                     aliases: '-v',
                     type: :string,
-                    desc: 'Filter relations by this field value',
+                    desc: I18n.t('field.flags.value'),
                     required: Sutty::Cli::Commands::Field.value_required?
 
       def field(name)
@@ -142,9 +146,13 @@ module Sutty
         end
       end
 
-      desc 'layout NAME', 'Start a new layout'
-      method_option :help, aliases: '-h', type: :boolean,
-                           desc: 'Display usage information'
+      desc I18n.t('layout.desc.example'), I18n.t('layout.desc.text')
+      method_option :help, aliases: '-h', type: :boolean, desc: I18n.t('help')
+      method_option :schema_only,
+                    aliases: '-s',
+                    type: :boolean,
+                    default: false,
+                    desc: I18n.t('layout.flags.schema_only')
       def layout(name)
         if options[:help]
           invoke :help, ['layout']
@@ -153,9 +161,8 @@ module Sutty
         end
       end
 
-      desc 'theme NAME', 'Start a new theme'
-      method_option :help, aliases: '-h', type: :boolean,
-                           desc: 'Display usage information'
+      desc I18n.t('theme.desc.example'), I18n.t('theme.desc.text')
+      method_option :help, aliases: '-h', type: :boolean, desc: I18n.t('help')
       def theme(name)
         if options[:help]
           invoke :help, ['theme']

data/lib/sutty/cli/commands/container.rb

@@ -6,6 +6,7 @@ require 'tty-command'
 module Sutty
   module Cli
     module Commands
+      # Genera un contenedor nuevo a partir del esqueleto.
       class Container < Sutty::Cli::Command
         attr_reader :name
 
@@ -26,10 +27,12 @@ module Sutty
 
         private
 
+        # @return [String]
         def origin
-          @origin ||= 'git@0xacab.org:sutty/containers/' + name + '.git'
+          @origin ||= "git@0xacab.org:sutty/containers/#{name}.git"
         end
 
+        # @return [TTY::Command]
         def cmd
           @cmd ||= TTY::Command.new
         end

data/lib/sutty/cli/commands/field.rb

@@ -1,8 +1,32 @@
 # frozen_string_literal: true
 
 require_relative '../command'
+require_relative '../../schema'
 require 'tty-file'
 require 'tty-logger'
+require 'active_support/core_ext/hash/keys'
+require 'active_support/core_ext/object/blank'
+
+class Hash
+  # Agrega una llave antes de otra
+  #
+  # @param [Any] La llave a buscar
+  # @param [Array] Array de dos elementos, el primero es la llave, el segundo el valor.
+  # @return [Hash]
+  # @see {https://stackoverflow.com/a/17251424}
+  def insert_before(key, kvpair)
+    arr = to_a
+    pos = arr.index(arr.assoc(key))
+
+    if pos
+      arr.insert(pos, kvpair)
+    else
+      arr << kvpair
+    end
+
+    replace Hash[arr]
+  end
+end
 
 module Sutty
   module Cli
@@ -10,75 +34,107 @@ module Sutty
       class Field < Sutty::Cli::Command
         attr_reader :name, :options
 
+        INVERSE_OF = {
+          'has_many' => 'belongs_to',
+          'belongs_to' => 'has_many',
+          'has_and_belongs_to_many' => 'has_and_belongs_to_many'
+        }.freeze
+
+        # Campos que requieren especificar la relación inversa
         INVERSE_REQUIRED = %w[has_many belongs_to has_and_belongs_to_many].freeze
+        # Opciones que necesitan un valor
         VALUE_REQUIRED = %w[-F --filter].freeze
+        # Nombres de campos que no se pueden usar
+        RESERVED_FIELDS = %w[url date path slug ext].freeze
 
         def initialize(name, options)
           @name = name
-          @options = options
+          @options = options.to_h.transform_keys(&:to_sym)
+          @options[:before] ||= 'order'
+
+          unless @options[:layout]
+            binding.pry
+            raise ArgumentError, 'layout option is missing'
+          end
         end
 
+        # TODO: Generar la relación inversa en el otro layout, a partir
+        # del filtro.
+        #
+        # @return [Boolean]
         def execute(input: $stdin, output: $stdout)
-          unless data_layout_contents.scan(/\n#{name}:\n/).empty?
-            logger.info "The #{name} field is already present, please edit #{data_layout}"
-            return true
+          @output = output
+
+          # Crea el layout si no existe
+          unless File.exist? layout_file
+            Sutty::Cli::Commands::Layout.new(options[:layout], {}).execute
           end
 
-          TTY::File.safe_append_to_file(data_layout) do
-            ERB.new(template_contents, trim_mode: '<>', eoutvar: '@output_buffer').result(context)
+          if RESERVED_FIELDS.include? name
+            logger.info I18n.t('field.errors.reserved', name: name)
+            return false
+          end
+
+          if layout_contents.key?(name) && !options[:force]
+            logger.info I18n.t('field.errors.already_exists', name: name)
+            return false
+          end
+
+          if INVERSE_REQUIRED.include?(options[:type]) && options[:inverse].blank? && options[:filter].blank?
+            logger.info I18n.t('field.errors.inverse_required', name: name)
+            return false
           end
-        end
 
-        def self.fields
-          @@fields ||= Dir.glob(source_dir.to_s + '/*.yml.erb').map do |f|
-            File.basename f, '.yml.erb'
+          layout_contents.insert_before options[:before],
+            Sutty::Schema.create(name: name, **options).to_a.flatten
+
+          # TODO: Mostrar el mismo mensaje de append_to_file
+          TTY::File.remove_file layout_file
+          TTY::File.create_file layout_file, YAML.dump(layout_contents.deep_stringify_keys)
+
+          # Agrega la relación inversa, creando el layout también.
+          if INVERSE_REQUIRED.include?(options[:type])
+            # XXX: No usar force aquí
+            Sutty::Cli::Commands::Field.new(options[:inverse],
+                                            layout: options[:value],
+                                            type: inverse_of(options[:type]),
+                                            filter: :layout,
+                                            value: options[:layout],
+                                            inverse: name).execute(output: output)
           end
+
+          layout_contents.key? name
         end
 
+        # Determina si la relación inversa es necesaria
         def self.inverse_required?
           ARGV.any? { |f| INVERSE_REQUIRED.include? f }
         end
 
+        # Determina si el valor es necesario
         def self.value_required?
           ARGV.any? { |f| VALUE_REQUIRED.include? f }
         end
 
         private
 
-        def self.source_dir
-          @@source_dir ||= Pathname(__dir__).join('..', 'templates', 'field')
-        end
-
-        def source_dir
-          self.class.source_dir
-        end
-
-        def context
-          return @context if @context
-          @context = OpenStruct.new(**options.transform_keys(&:to_sym))
-          @context[:name] = name
-
-          @context = @context.instance_eval('binding')
+        def layout_file
+          @data_file ||= File.join('_data', 'layouts', options[:layout] + '.yml')
         end
 
-        def template
-          @template ||= source_dir.join(options[:type] + '.yml.erb')
+        def layout_contents
+          @layout_contents ||= YAML.load(File.read(layout_file))
         end
 
-        def template_contents
-          @template_contents ||= File.binread template
-        end
-
-        def data_layout
-          @data_layout ||= File.join('_data', 'layouts', options[:layout] + '.yml')
-        end
-
-        def data_layout_contents
-          @data_layout_contents ||= File.binread data_layout
+        def logger
+          @logger ||= TTY::Logger.new(output: @output)
         end
 
-        def logger
-          @logger ||= TTY::Logger.new
+        # Devuelve la relación inversa
+        #
+        # @return [String]
+        def inverse_of(type)
+          INVERSE_OF[type]
         end
       end
     end

data/lib/sutty/cli/commands/layout.rb

@@ -1,55 +1,68 @@
 # frozen_string_literal: true
 
 require_relative '../command'
+require_relative '../../schema'
 require 'tty-file'
 require 'yaml'
+require 'active_support/core_ext/hash/keys'
 
 module Sutty
   module Cli
     module Commands
+      # Crea un layout de Jekyll y su layout correspondiente en Sutty.
+      #
+      # _data/layouts/NAME.yml: Definición del layout para Sutty
+      # _layouts/NAME.yml: La plantilla Liquid para Jekyll (opcional)
       class Layout < Sutty::Cli::Command
         attr_reader :name
 
-        def initialize(name, options)
+        # @param [String] Nombre del layout
+        # @param [Hash] Opciones
+        def initialize(name, options = {})
           @name = name
           @options = options
         end
 
+        # Crea los dos archivos sin pisarlos si ya existen
+        #
+        # @return [Boolean] Si el archivo fue creado o no
         def execute(input: $stdin, output: $stdout)
-          TTY::File.create_file data_layout, YAML.dump(data_default_fields)
-          TTY::File.create_file html_layout, "---\nlayout: default\n---\n\n"
+          TTY::File.create_file data_layout, YAML.dump(default_fields.deep_stringify_keys)
+
+          unless @options[:schema_only]
+            TTY::File.create_file html_layout, "---\nlayout: default\n---\n\n"
+          end
+
+          File.exist? data_layout
         end
 
+        # Devuelve el listado de layouts disponibles
+        #
+        # @return [Array]
         def self.layouts
-          @@layouts ||= Dir.glob(File.join('_data', 'layouts') + '/*.yml').map do |d|
+          @layouts ||= Dir.glob("#{File.join('_data', 'layouts')}/*.yml").map do |d|
             File.basename d, '.yml'
-          end
+          end.sort
         end
 
         private
 
-        def data_default_fields
-          @data_default_fields ||= {
-            'title' => {
-              'type' => 'string',
-              'label' => {
-                'es' => 'Título',
-                'en' => 'Title'
-              },
-              'help' => {
-                'es' => '',
-                'en' => ''
-              }
-            }
-          }
+        def default_fields
+          @default_fields ||= [
+            Sutty::Schema.string_field(name: :title, required: true),
+            Sutty::Schema.order_field(name: :order),
+            Sutty::Schema.boolean_field(name: :draft)
+          ].inject(&:merge)
         end
 
+        # @return [String]
         def data_layout
-          @data_layout ||= File.join('_data', 'layouts', name + '.yml')
+          @data_layout ||= File.join('_data', 'layouts', "#{name}.yml")
         end
 
+        # @return [String]
         def html_layout
-          @html_layout ||= File.join('_layouts', name + '.html')
+          @html_layout ||= File.join('_layouts', "#{name}.html")
         end
       end
     end