Contents

# encoding: utf-8
require 'rails_best_practices/reviews/review'

module RailsBestPractices
  module Reviews
    # Check ruby 1.8 style hash and suggest to change hash syntax to 1.9.
    #
    # Review process:
    #   check hash nodes in all files,
    #   if the sexp type of hash key nodes is not :@lable,
    #   then the hash is ruby 1.8 style.
    class HashSyntaxReview < Review
      interesting_nodes :hash, :bare_assoc_hash
      interesting_files ALL_FILES

      def initialize(options = {})
        super()
        @only_symbol = options[:only_symbol]
        @only_string = options[:only_string]
      end

      # check hash node to see if it is ruby 1.8 style.
      def start_hash(node)
        return if s(:hash, nil) == node
        pair_nodes = node[1][1]

        if hash_is_18?(pair_nodes)
          add_error "change Hash Syntax to 1.9"
        end
      end

      # check bare_assoc_hash node to see if it is ruby 1.8 style.
      def start_bare_assoc_hash(node)
        pair_nodes = node[1]

        if hash_is_18?(pair_nodes)
          add_error "change Hash Syntax to 1.9"
        end
      end

      protected
        # check if hash key/value pairs are ruby 1.8 style.
        #
        # hash key of ruby 1.9 style is :@label,
        # so if it is not, then it is ruby 1.8 style.
        def hash_is_18?(pair_nodes)
          return false if pair_nodes.blank?
          pair_nodes.size.times do |i|
            if @only_symbol
              return true if :symbol_literal == pair_nodes[i][1].sexp_type
            elsif @only_string
              return true if :string_literal == pair_nodes[i][1].sexp_type
            elsif :@label != pair_nodes[i][1].sexp_type
              return true
            end
          end

          false
        end
    end
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
rails_best_practices-1.10.0	lib/rails_best_practices/reviews/hash_syntax_review.rb