frontline 0.0.7

data/lib/frontline/controllers/models.rb

@@ -0,0 +1,104 @@
+class Frontline
+  class Models < E
+    reject_automount!
+
+    # runs before new model generated.
+    # converts throughFor Hash, if any, into string options suitable for Enginery.
+    before :post_model do
+      (params.delete('throughFor') || {}).each_pair do |a,t|
+        next if (assoc = params[a].to_s.strip).empty? || (through = t.strip).empty?
+        params[a] = [assoc, 'through', through]*':'
+      end
+    end
+
+    # return a command that will generate a new model.
+    # `@name` and `@setups` variables are set by the triggered hooks(see frontline/app.rb for hooks)
+    def post_model
+      'generate:model %s %s' % [@name, @setups]
+    end
+
+    # return a command that will delete the given model.
+    # `@name` variable are set by the triggered hooks(see frontline/app.rb for hooks)
+    def delete_model
+      'delete:model:yes %s' % @name
+    end
+
+    # return a command that will generate a new migration for given model.
+    # `@name` and `@setups` variables are set by the triggered hooks(see frontline/app.rb for hooks)
+    def post_migration model
+      'm %s model:%s %s' % [@name, model, @setups]
+    end
+
+    # return a command that will delete the given migration of given model.
+    # `@name` variable are set by the triggered hooks(see frontline/app.rb for hooks)
+    def delete_migration model
+      'delete:migration:yes %s' % @name
+    end
+
+    # run given migration or outstanding ones if no migrations given.
+    # see `Helpers#pty_stream` for running/streaming details.
+    #
+    # it requires `:vector` param to be set to "up" or "down".
+    # by default it will skip already performed migrations
+    # if `:force_run` is set, it will run migrations regardless performed state.
+    # if `:force_run` NOT set, `:force_yes` option should be set to true
+    # to avoid any confirmation prompts generated by Enginery.
+    def post_run_migrations
+      @uuid  = params[:uuid]
+      vector = params[:vector]
+      extra  = params[:force_run] ? ':f' : (params[:force_yes] ? ':y' : '')
+      migrations = (params[:migrations]||[])*' '
+      cmd = 'bundle exec enginery m:%s%s %s' % [vector, extra, migrations]
+      stream do
+        pty_stream 'modal', 'show'
+        passed, failure_id = pty_spawn(cmd)
+        if passed
+          pty_stream 'modal', 'hide'
+        else
+          pty_stream 'failures', failure_id
+        end
+      end
+    end
+
+    # run given DataMapper migrate task and stream result to browser.
+    # see `Helpers#pty_stream` for running/streaming details.
+    def post_run_datamapper_task task, model = nil
+      
+      %w[auto_migrate auto_upgrade].include?(task) ||
+        halt(400, 'Unknown DataMapper task "%s"' % escape_html(task))
+
+      @uuid = params.delete('uuid')
+      cmd = 'rake dm:' + task
+      model && cmd << ':' << model
+
+      stream do
+        pty_stream 'modal', 'show'
+        passed, failure_id = pty_spawn(cmd)
+        if passed
+          pty_stream 'modal', 'hide'
+        else
+          pty_stream 'failures', failure_id
+        end
+      end
+    end
+
+    # boot effective application and get last track for given migration
+    def last_run
+      Dir.chdir dst_path.root do
+        migrator = Enginery::Migrator.new(dst_path.root)
+        migrator.boot_app
+        if track = migrator.last_run(params[:file])
+          '%s on %s' % [track.first.upcase, track.last]
+        else
+          'Never'
+        end
+      end
+    end
+
+    def migration_layout model
+      model = models[model] || halt(400, '"%s" model does not exists' % escape_html(model))
+      render_p model: model
+    end
+
+  end
+end

data/lib/frontline/controllers/sources.rb

@@ -0,0 +1,11 @@
+class Frontline
+  class Sources < E
+    reject_automount!
+    include EL::Finder
+
+    # asking el-finder to generate a file manager for editing effective application
+    def index
+      render_l { finder(dst_path.root, editor: :ace) }
+    end
+  end
+end

data/lib/frontline/frontline.rb

@@ -0,0 +1,11 @@
+class Frontline
+           ROOT = (File.expand_path('../../..', __FILE__) + '/').freeze
+      TEMPLATES = (ROOT + 'lib/frontline/templates/').freeze
+         ASSETS = (ROOT + 'assets/').freeze
+  ASSETS_SUFFIX = '-frontline'.freeze
+  ASSETS_REGEXP = /#{Regexp.escape ASSETS_SUFFIX}/.freeze
+        STREAMS = {}
+    CONTROLLERS = {}
+         MODELS = {}
+           PORT = 5000
+end

data/lib/frontline/helpers.rb

@@ -0,0 +1,179 @@
+class Frontline
+  module Helpers
+    include Inflector
+
+    # send data to browser via EventSource socket.
+    # socket should be earlier set via `Index#get_streamer`.
+    # actions calling this helper should firstly set `@uuid` variable.
+    #
+    # @param [String] event
+    #    event to be sent to browser
+    # @param [String] data
+    #    data to be sent to browser
+    def pty_stream event, data = ''
+      return unless stream = STREAMS[@uuid]
+      stream.event event
+      stream.data  data
+    end
+
+    # return the list of managed applications.
+    def applications
+      (a = cookies['Applications']) ? JSON.load(a) : []
+    end
+
+    # return the list of controllers for effective application
+    def controllers
+      return CONTROLLERS[dst_path.root] if CONTROLLERS[dst_path.root]
+      result = enginery_registry(:c)
+      return CONTROLLERS[dst_path.root] = result if result.is_a?(Hash)
+      result
+    end
+
+    # return the list of models for effective application
+    def models
+      return MODELS[dst_path.root] if MODELS[dst_path.root]
+      result = enginery_registry(:m)
+      return MODELS[dst_path.root] = result if result.is_a?(Hash)
+      result
+    end
+
+    # execute a enginery registry command.
+    # data are extracted via `$ enginery -c` command so it comes in YAML format.
+    # if call was successful, parse the YAML and return the result as a Hash.
+    # otherwise return the stdout+stderr as a String.
+    # if YAML parser failing, a exception will be raised.
+    def enginery_registry unit
+      Dir.chdir dst_path.root do
+        cmd = '%s -%s' % [Enginery::EXECUTABLE, unit]
+        stdout, stderr, status = Open3.capture3(cmd)
+        if status && status.exitstatus == 0
+          YAML.load(stdout)
+        else
+          [stdout, stderr].join("\n")
+        end
+      end
+    end
+
+    def stringify_application name, path, url
+      JSON.dump([name, path, url])
+    end
+
+    # running given command via `PTY.spawn` and streaming each line to browser.
+    # actions calling this helper should firstly set `@uuid` variable for streaming to work.
+    #
+    # before executing given cmd it will change working directory
+    # to effective application root(see `Index#get_application`).
+    # 
+    # if some exception raised it will be rescued
+    # and error message alongside backtrace will be streamed to browser.
+    #
+    # it returns an Array first element of which is the status
+    # and the second is a unique ID used to identify lines generated by given cmd.
+    # if status is negative, actions calling this helper will can identify
+    # lines and mark them as errored.
+    #
+    def pty_spawn cmd, opts = {}
+      failure_id = 'pty_' << cmd.__id__.to_s
+      root = opts[:root] || dst_path.root
+      pty_stream 'content', div_tag!('$ cd ' << root, class: 'muted')
+      pty_stream 'content', div_tag!(b_tag('$ ' << cmd, class: 'text-info'))
+      Dir.chdir root do
+        PTY.spawn cmd do |r, w, pid|
+          begin
+            r.sync
+            r.each_line do |line|
+              line.rstrip!
+              
+              # div_tag will escape line before emitting it
+              html = line.empty? ? br_tag : div_tag(line, class: failure_id)
+              
+              pty_stream 'content', html
+              
+            end
+          rescue Errno::EIO # simply ignoring this
+          ensure
+            ::Process.wait pid
+          end
+        end
+      end
+      [$? && $?.exitstatus == 0, failure_id]
+    rescue => e
+      pty_stream 'content', p_tag(e.message)
+      e.backtrace.each {|l| pty_stream('content', div_tag(l))}
+      [false, failure_id]
+    end
+
+    def maintenance_files
+      files = %w[ 
+        Gemfile
+        Rakefile
+        base/boot.rb
+        config/config.yml
+        config/database.yml
+        base/helpers/application_helpers.rb
+      ]
+      Dir[dst_path(:views, 'layout*')].each do |e|
+        File.file?(e) && files.unshift('base/views/' + File.basename(e))
+      end
+      files
+    end
+
+    # determine whether effective application is using DataMapper ORM
+    def datamapper?
+      (m = models) && m.is_a?(Hash) && (m = models.values.first) && m[:orm].to_s =~ /\Ad/i
+    end
+
+    @@association_hints = {}
+    def association_hints
+      @@association_hints[models.__id__] ||= models.keys.map {|x| underscore(x.to_s)}
+    end
+
+    def singularized_association_hints
+      association_hints.map {|m| singularize(m)}
+    end
+
+    def pluralized_association_hints
+      association_hints.map {|m| pluralize(m)}
+    end
+
+    def association_hint_class assoc
+      assoc == :belongs_to || assoc == :has_one ?
+        'singularized_association_hints' :
+        'pluralized_association_hints'
+    end
+
+    def clear_registry_cache!
+      CONTROLLERS.clear
+      MODELS.clear
+    end
+
+    def postcrud_handlers
+      cache = if action_name[0] == 'm'
+        MODELS.delete(dst_path.root)
+        models()
+      else
+        CONTROLLERS.delete(dst_path.root)
+        controllers()
+      end
+
+      errors = []
+      if cache.is_a?(Hash)
+        begin
+          pty_stream 'render', render_p(action_name, action_params)
+          pty_stream 'modal', 'hide'
+        rescue => e
+          errors = [e.message] + e.backtrace
+        end
+      else
+        errors = cache.to_s.split("\n")
+      end
+      if errors.any?
+        html = hr_tag << div_tag(class: 'alert alert-error lead') {
+          'Error loading %ss' % action_name
+        } << errors.map {|e| div_tag(e, class: 'text-error')}.join
+        pty_stream('content', html)
+      end
+    end
+
+  end
+end

data/lib/frontline/inflect.rb

@@ -0,0 +1,183 @@
+class Frontline
+  module Inflector
+    extend self
+
+    class Inflections
+      @__instance__ = {}
+
+      def self.instance(locale = :en)
+        @__instance__[locale] ||= new
+      end
+
+      attr_reader :plurals, :singulars, :uncountables
+
+      def initialize
+        @plurals, @singulars, @uncountables = [], [], []
+      end
+
+      # Specifies a new pluralization rule and its replacement. The rule can
+      # either be a string or a regular expression. The replacement should
+      # always be a string that may include references to the matched data from
+      # the rule.
+      def plural(rule, replacement)
+        @uncountables.delete(rule) if rule.is_a?(String)
+        @uncountables.delete(replacement)
+        @plurals.unshift([rule, replacement])
+      end
+
+      # Specifies a new singularization rule and its replacement. The rule can
+      # either be a string or a regular expression. The replacement should
+      # always be a string that may include references to the matched data from
+      # the rule.
+      def singular(rule, replacement)
+        @uncountables.delete(rule) if rule.is_a?(String)
+        @uncountables.delete(replacement)
+        @singulars.unshift([rule, replacement])
+      end
+
+      # Add uncountable words that shouldn't be attempted inflected.
+      #
+      #   uncountable 'money'
+      #   uncountable 'money', 'information'
+      #   uncountable %w( money information rice )
+      def uncountable(*words)
+        (@uncountables << words).flatten!
+      end
+    end
+
+    # Yields a singleton instance of Inflector::Inflections so you can specify
+    # additional inflector rules. If passed an optional locale, rules for other
+    # languages can be specified. If not specified, defaults to <tt>:en</tt>.
+    # Only rules for English are provided.
+    #
+    #   ActiveSupport::Inflector.inflections(:en) do |inflect|
+    #     inflect.uncountable 'rails'
+    #   end
+    def inflections(locale = :en)
+      if block_given?
+        yield Inflections.instance(locale)
+      else
+        Inflections.instance(locale)
+      end
+    end
+  end
+
+  Inflector.inflections(:en) do |inflect|
+    inflect.plural(/$/, 's')
+    inflect.plural(/s$/i, 's')
+    inflect.plural(/^(ax|test)is$/i, '\1es')
+    inflect.plural(/(octop|vir)us$/i, '\1i')
+    inflect.plural(/(octop|vir)i$/i, '\1i')
+    inflect.plural(/(alias|status)$/i, '\1es')
+    inflect.plural(/(bu)s$/i, '\1ses')
+    inflect.plural(/(buffal|tomat)o$/i, '\1oes')
+    inflect.plural(/([ti])um$/i, '\1a')
+    inflect.plural(/([ti])a$/i, '\1a')
+    inflect.plural(/sis$/i, 'ses')
+    inflect.plural(/(?:([^f])fe|([lr])f)$/i, '\1\2ves')
+    inflect.plural(/(hive)$/i, '\1s')
+    inflect.plural(/([^aeiouy]|qu)y$/i, '\1ies')
+    inflect.plural(/(x|ch|ss|sh)$/i, '\1es')
+    inflect.plural(/(matr|vert|ind)(?:ix|ex)$/i, '\1ices')
+    inflect.plural(/^(m|l)ouse$/i, '\1ice')
+    inflect.plural(/^(m|l)ice$/i, '\1ice')
+    inflect.plural(/^(ox)$/i, '\1en')
+    inflect.plural(/^(oxen)$/i, '\1')
+    inflect.plural(/(quiz)$/i, '\1zes')
+
+    inflect.singular(/s$/i, '')
+    inflect.singular(/(ss)$/i, '\1')
+    inflect.singular(/(n)ews$/i, '\1ews')
+    inflect.singular(/([ti])a$/i, '\1um')
+    inflect.singular(/((a)naly|(b)a|(d)iagno|(p)arenthe|(p)rogno|(s)ynop|(t)he)(sis|ses)$/i, '\1sis')
+    inflect.singular(/(^analy)(sis|ses)$/i, '\1sis')
+    inflect.singular(/([^f])ves$/i, '\1fe')
+    inflect.singular(/(hive)s$/i, '\1')
+    inflect.singular(/(tive)s$/i, '\1')
+    inflect.singular(/([lr])ves$/i, '\1f')
+    inflect.singular(/([^aeiouy]|qu)ies$/i, '\1y')
+    inflect.singular(/(s)eries$/i, '\1eries')
+    inflect.singular(/(m)ovies$/i, '\1ovie')
+    inflect.singular(/(x|ch|ss|sh)es$/i, '\1')
+    inflect.singular(/^(m|l)ice$/i, '\1ouse')
+    inflect.singular(/(bus)(es)?$/i, '\1')
+    inflect.singular(/(o)es$/i, '\1')
+    inflect.singular(/(shoe)s$/i, '\1')
+    inflect.singular(/(cris|test)(is|es)$/i, '\1is')
+    inflect.singular(/^(a)x[ie]s$/i, '\1xis')
+    inflect.singular(/(octop|vir)(us|i)$/i, '\1us')
+    inflect.singular(/(alias|status)(es)?$/i, '\1')
+    inflect.singular(/^(ox)en/i, '\1')
+    inflect.singular(/(vert|ind)ices$/i, '\1ex')
+    inflect.singular(/(matr)ices$/i, '\1ix')
+    inflect.singular(/(quiz)zes$/i, '\1')
+    inflect.singular(/(database)s$/i, '\1')
+
+    inflect.uncountable(%w(equipment information rice money species series fish sheep jeans police))
+  end
+
+  module Inflector
+    extend self
+
+    # Returns the plural form of the word in the string.
+    #
+    # If passed an optional +locale+ parameter, the word will be
+    # pluralized using rules defined for that language. By default,
+    # this parameter is set to <tt>:en</tt>.
+    #
+    #   'post'.pluralize             # => "posts"
+    #   'octopus'.pluralize          # => "octopi"
+    #   'sheep'.pluralize            # => "sheep"
+    #   'words'.pluralize            # => "words"
+    #   'CamelOctopus'.pluralize     # => "CamelOctopi"
+    #   'ley'.pluralize(:es)         # => "leyes"
+    def pluralize(word, locale = :en)
+      apply_inflections(word, inflections(locale).plurals)
+    end
+
+    # The reverse of +pluralize+, returns the singular form of a word in a
+    # string.
+    #
+    # If passed an optional +locale+ parameter, the word will be
+    # pluralized using rules defined for that language. By default,
+    # this parameter is set to <tt>:en</tt>.
+    #
+    #   'posts'.singularize            # => "post"
+    #   'octopi'.singularize           # => "octopus"
+    #   'sheep'.singularize            # => "sheep"
+    #   'word'.singularize             # => "word"
+    #   'CamelOctopi'.singularize      # => "CamelOctopus"
+    #   'leyes'.singularize(:es)       # => "ley"
+    def singularize(word, locale = :en)
+      apply_inflections(word, inflections(locale).singulars)
+    end
+
+    def underscore(camel_cased_word)
+      word = camel_cased_word.to_s.dup
+      word.gsub!('::', '/')
+      word.gsub!(/(?:([A-Za-z\d])|^)((?=a)b)(?=\b|[^a-z])/) { "#{$1}#{$1 && '_'}#{$2.downcase}" }
+      word.gsub!(/([A-Z\d]+)([A-Z][a-z])/,'\1_\2')
+      word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+      word.tr!("-", "_")
+      word.downcase!
+      word
+    end
+
+    private
+    
+    # Applies inflection rules for +singularize+ and +pluralize+.
+    #
+    #  apply_inflections('post', inflections.plurals)    # => "posts"
+    #  apply_inflections('posts', inflections.singulars) # => "post"
+    def apply_inflections(word, rules)
+      result = word.to_s.dup
+      if word.empty? || inflections.uncountables.include?(result.downcase[/\b\w+\Z/])
+        result
+      else
+        rules.each { |(rule, replacement)| break if result.sub!(rule, replacement) }
+        result
+      end
+    end
+
+  end
+end